Repository navigation
Commit 6d81c05
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,6 +5,10 @@ including the [Prevent agent impersonation](CONTRIBUTING.md#prevent-agent-impers | |||
| 5 | 5 | section governing agent identification and separation of unaltered user statements | |
| 6 | 6 | when communicating through a person's account. | |
| 7 | 7 | ||
| 8 | + [Prefer pull requests](CONTRIBUTING.md#prefer-pull-requests): a PR can serve as an | ||
| 9 | + issue with a fix attached. Do not create an issue solely to follow it immediately | ||
| 10 | + with a PR that fixes it; describe the problem in the PR instead. | ||
| 11 | + | ||
| 8 | 12 | # Commit messages | |
| 9 | 13 | ||
| 10 | 14 | Follow Conventional Commits for every commit. Every commit must have a | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -9,6 +9,16 @@ The following is a short step-by-step rundown of what one typically would do to | |||
| 9 | 9 | - Feel free to add yourself to AUTHORS file. | |
| 10 | 10 | - Create a pull request. | |
| 11 | 11 | ||
| 12 | + ## Prefer pull requests | ||
| 13 | + | ||
| 14 | + Pull requests are preferred when you have a fix or improvement to contribute: a PR | ||
| 15 | + can be treated as an issue with a fix attached. Describe the problem and proposed | ||
| 16 | + solution in the PR itself; a separate issue is not required. | ||
| 17 | + | ||
| 18 | + Please avoid opening an issue solely to follow it immediately with a PR that fixes | ||
| 19 | + it. Open the PR directly instead. Issues are still welcome for problems without a | ||
| 20 | + fix or for changes that need discussion before implementation. | ||
| 21 | + | ||
| 12 | 22 | ## Quality expectations | |
| 13 | 23 | ||
| 14 | 24 | Contributions must be made with care and meet the quality bar of the surrounding code. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -201,8 +201,12 @@ Please have a look at the [contributions file][contributing]. | |||
| 201 | 201 | - [Questions and Answers](http://stackexchange.com/filters/167317/gitpython) | |
| 202 | 202 | - Please post on Stack Overflow and use the `gitpython` tag | |
| 203 | 203 | - [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues) | |
| 204 | - - Post reproducible bugs and feature requests as a new issue. | ||
| 205 | - Please be sure to provide the following information if posting bugs: | ||
| 204 | + - Post reproducible bugs and feature requests as a new issue when you do not have | ||
| 205 | + a fix or need discussion before implementation. If you have a fix or improvement, | ||
| 206 | + [open a pull request directly](CONTRIBUTING.md#prefer-pull-requests) and describe | ||
| 207 | + the problem there; you do not need to create an issue first. | ||
| 208 | + Please be sure to provide the following information when reporting bugs in an | ||
| 209 | + issue or PR: | ||
| 206 | 210 | - GitPython version (e.g. `import git; git.__version__`) | |
| 207 | 211 | - Python version (e.g. `python --version`) | |
| 208 | 212 | - The encountered stack-trace, if applicable | |
0 commit comments