mirror of https://github.com/logseq/logseq
parent
cd4ff36c5f
commit
80d63e079f
|
@ -80,7 +80,7 @@ body:
|
|||
label: Are you willing to submit a PR? If you know how to fix the bug.
|
||||
description: |
|
||||
If you are not familiar with programming, you can skip this step.
|
||||
If you are a developer and know how to fix the bug, you can submit a PR to fix it. You can find the [contributing guide](https://github.com/logseq/logseq#how-to-contribute-with-a-pr) here.
|
||||
If you are a developer and know how to fix the bug, you can [submit a PR to fix it](https://github.com/logseq/logseq/blob/master/CONTRIBUTING.md#submit-pr).
|
||||
Your contributions are greatly appreciated and play a vital role in helping to improve the project!
|
||||
options:
|
||||
- label: I'm willing to submit a PR (Thank you!)
|
||||
|
|
|
@ -25,7 +25,8 @@ There are many ways you can help:
|
|||
- You can be help others on [Discord][discord] or [Reddit](https://www.reddit.com/r/logseq).
|
||||
- You can [contribute to the official docs](https://github.com/logseq/docs/blob/master/CONTRIBUTING.md).
|
||||
- You can confirm bugs on the [issue tracker][issue-tracker] and mention reproducible steps. It helps the core team to get more reports so we can fix the highest priority bugs.
|
||||
- You can contribute code. See [our Project board](https://github.com/orgs/logseq/projects/5/views/1) for ideas.
|
||||
- You can contribute [translations][translations] with a [pull request](#submit-pr).
|
||||
- You can contribute code with a [pull request](#submit-pr). See [our Project board](https://github.com/orgs/logseq/projects/5/views/1?pane=info) and [good first issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) for ideas.
|
||||
- You can extend Logseq with [plugins](https://docs.logseq.com/#/page/Plugins) to share functionality that our community can benefit from.
|
||||
|
||||
## <a name="question"></a> Got a Question or a Problem?
|
||||
|
@ -84,7 +85,13 @@ behavior and design you'd like to add.
|
|||
3. Please sign our [Contributor License Agreement (CLA)](#cla). We cannot accept
|
||||
code without a signed CLA.
|
||||
|
||||
After doing the above, you are ready to work on your PR! If you've never done this before, see [Github's excellent guides](https://docs.github.com/en/pull-requests).
|
||||
After doing the above, you are ready to work on your PR! To create a PR, fork
|
||||
this repository and then create a branch for the fix. Once you push your code to
|
||||
your fork, you'll be able to open a PR to the Logseq repository. For more info
|
||||
you can follow this [GitHub
|
||||
guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
|
||||
For more github PR guides, see [these
|
||||
guides](https://docs.github.com/en/pull-requests).
|
||||
|
||||
### PR Guidelines
|
||||
|
||||
|
@ -98,7 +105,7 @@ When submitting a Pull Request (PR) or expecting a subsequent review, please fol
|
|||
|
||||
4. The PR has [test(s)](https://github.com/logseq/logseq/blob/master/docs/dev-practices.md#testing) for features or enhancements. Tests for bug fixes are also appreciated as they help prevent regressions.
|
||||
|
||||
5. The PR has a descriptive title that a user can understand. We use these titles to generate changelogs for the user. Most titles use one of the following prefixes:
|
||||
5. The PR has a descriptive title that a user can understand. We use these titles to generate changelogs for the user. Most titles use one these prefixes to categorize the PR e.g. `PREFIX: DESCRIPTION ...`:
|
||||
* `chore` - Misc changes that aren't dev, feat or fix
|
||||
* `dev` - Developer related changes
|
||||
* `enhance` - Enhancements i.e. changes to existing features
|
||||
|
@ -106,7 +113,9 @@ When submitting a Pull Request (PR) or expecting a subsequent review, please fol
|
|||
* `fix` - Bug fixes
|
||||
* `test` - Test only changes
|
||||
|
||||
6. The PR avoids the following changes that are not helpful to the core team:
|
||||
6. The PR having "allow edits from maintainers" enabled would be appreciated. Helps us help your contribution.
|
||||
|
||||
7. The PR avoids the following changes that are not helpful to the core team:
|
||||
* Unrelated refactoring or heavy refactoring
|
||||
* Code or doc formatting changes including whitespace changes
|
||||
|
||||
|
|
12
README.md
12
README.md
|
@ -87,17 +87,9 @@ We have [a dedicated overview page](https://github.com/logseq/logseq/blob/master
|
|||
|
||||
There are more guides in [docs/](docs/), e.g. the [Guide for contributing to translations](docs/contributing-to-translations.md) and the [Docker web app guide](docs/docker-web-app-guide.md)
|
||||
|
||||
## How to contribute with a PR
|
||||
If you would like to contribute by solving an open issue, please fork this repository and then create a branch for the fix.
|
||||
## Contributing
|
||||
|
||||
Once you push your code to your fork, you'll be able to open a PR into Logseq repository. For more info you can follow this guide from [GitHub docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
|
||||
|
||||
Enabling "allow edits from maintainers" for PR is highly appreciated!
|
||||
|
||||
There's a nice [project board](https://github.com/orgs/logseq/projects/5/views/1?pane=info
|
||||
) listing items that easy for contributors to catch-up
|
||||
|
||||
And here a list of some [good first issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
## Thanks
|
||||
|
||||
|
|
Loading…
Reference in New Issue