wneessen/apg-go
1
1
Fork 0
mirror of https://github.com/wneessen/apg-go.git synced 2024-11-23 06:10:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add CONTRIBUTING.md with contribution guidelines

Browse source 
The file CONTRIBUTING.md has been added to provide clear guidelines for contributors seeking to make pull requests to the project. This includes instructions on how to create effective pull requests, maintain clean commit history, and keep PRs up to date.
This commit is contained in:
Winni Neessen 2024-03-18 00:04:05 +01:00
parent afac8e8f0e
commit f9314bc07c
Signed by: wneessen
GPG key ID: 5F3AF39B820C119D
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,27 @@
<!--
SPDX-FileCopyrightText: 2021-2024 Winni Neessen <wn@neessen.dev>
SPDX-License-Identifier: CC0-1.0
-->
# How to contribute
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
## Guidelines for Pull Requests
How to get your contributions merged smoothly and quickly.
* Create **small PRs** that are narrowly focused on **addressing a single concern**. We often times receive PRs that are trying to fix several things at a time, but only one fix is considered acceptable, nothing gets merged and both author's & review's time is wasted. Create more PRs to address different concerns and everyone will be happy.
* For speculative changes, consider opening an issue and discussing it first.
* Provide a good **PR description** as a record of **what** change is being made and **why** it was made. Link to a github issue if it exists.
* Unless your PR is trivial, you should expect there will be reviewer comments that you'll need to address before merging. We expect you to be reasonably responsive to those comments, otherwise the PR will be closed after 2-3 weeks of inactivity.
* Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult to review and won't be merged. Use `rebase -i upstream/main` to curate your commit history and/or to bring in latest changes from main (but avoid rebasing in the middle of a code review).
* Keep your PR up to date with upstream/main (if there are merge conflicts, we can't really merge your change).
* Exceptions to the rules can be made if there's a compelling reason for doing so.