mirror of
https://github.com/abapGit/abapGit.git
synced 2025-04-30 20:03:20 +08:00
Improvements to contribution guidelines (#2728)
This commit is contained in:
parent
6845fe3ea4
commit
6a25e45d8f
|
@ -1,3 +1,15 @@
|
|||
## General advice
|
||||
|
||||
* If you're new and want to help out, try one of [these](https://github.com/larshp/abapGit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). They should not be complicated to implement but require you to get the project up and running. Or pick something that annoys you. Fix a typo. Improve an error message. Correct some [coding conventions](https://docs.abapgit.org/development/guidelines.html). Or try something unusual just to see if it works and if it doesn't, open an issue.
|
||||
|
||||
* Before starting any significant development, open an issue and propose your solution first. A discussion can save a lot of unnecessary work. It also helps others know that this is being worked on.
|
||||
|
||||
* It is in your best interest to keep the commits/PRs as small as possible and solve one thing at a time. The smaller your change is, the easier it is to review and it will be more likely to get accepted.
|
||||
|
||||
* Commit often, whenever something is working, and is a step in the right direction do a commit or PR. This way other contributors can see the changes, and it will minimize the risk of merge conflicts.
|
||||
|
||||
* If you don't have the time or knowledge to fix the problem yourself, you can still make it move along faster by providing an accurate description or a repo which reproduces the issue.
|
||||
|
||||
## Bug Reports
|
||||
|
||||
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
|
||||
|
|
|
@ -30,9 +30,13 @@ Recommend using SAP GUI for Windows, there are multiple issues related to runnin
|
|||
## Documentation/Guides
|
||||
http://docs.abapgit.org
|
||||
|
||||
## Contributing
|
||||
|
||||
You can find the contribution guidelines [here](CONTRIBUTING.md).
|
||||
|
||||
## Projects using abapGit
|
||||
|
||||
See [dotabap.org](http://dotabap.org)
|
||||
See [dotabap.org](http://dotabap.org) or [this page](https://docs.abapgit.org/other-where-used.html).
|
||||
|
||||
## FAQ
|
||||
For questions/comments/bugs/feature requests/wishes please create an [issue](https://github.com/larshp/abapGit/issues)
|
||||
|
|
|
@ -3,6 +3,10 @@ title: Contributing
|
|||
order: 5
|
||||
---
|
||||
|
||||
General contribution guidelines can be found [here](https://github.com/larshp/abapGit/blob/master/CONTRIBUTING.md).
|
||||
|
||||
How to submit a pull request:
|
||||
|
||||
*******************************
|
||||
|
||||
1: Install the development version of abapGit by cloning the repository using an online repository, or downloading the zip file and installing it using an offline repository.
|
||||
|
|
|
@ -3,17 +3,6 @@ title: Development Guidelines
|
|||
order: 10
|
||||
---
|
||||
|
||||
### Practical
|
||||
|
||||
* For non-trivial changes make sure there is an open issue. When starting the development add a comment in the issue. This will allow for discussing possible solutions, and avoid having multiple people look into the same issue.
|
||||
|
||||
* Keep the commits/PR as small as possible, try not to fix multiple issues in one commit/PR if possible. Smaller changes are easier to review, and are more likely to be accepted.
|
||||
|
||||
* commit often, whenever something is working, and is a step in the right direction do a commit or PR. This way other contributors can see the changes, and it will minimize the risk of merge conflicts.
|
||||
|
||||
External Links:
|
||||
[https://guides.github.com/activities/contributing-to-open-source/](https://guides.github.com/activities/contributing-to-open-source/)
|
||||
|
||||
### Conventions
|
||||
|
||||
#### Prefixing
|
||||
|
|
Loading…
Reference in New Issue
Block a user