CopyBot/PlexDBRepair
1
0
Fork 0
mirror of https://github.com/ChuckPa/PlexDBRepair.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #63 from ChuckPa/chuckpa/contributing

Browse Source 
Contributing:  Clarify guidelines.
This commit is contained in:
Chuck 2023-04-19 11:31:57 -04:00 committed by GitHub
commit 4b4e5fdf48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Contributing.md
View File

@ -8,22 +8,28 @@ To contribute to the project, please follow the following instructions:
### Open an Issue describing the problem or enhancement. ### Open an Issue describing the problem or enhancement.
- Add a label to the issue - Add a label to the issue
### When submitting your work for review and merge: ### When submitting your work for review and merge:
1. Prior to opening a pull request, 1. Prior to opening a pull request,
- Be certain to REBASE prior to opening the PR
- Squash multiple commits into a single commit. - Squash multiple commits into a single commit.
- Clean up the commit message after squashing. - Clean up the commit message after squashing.
- Use force-push to unify all changes. - Use force-push if needed to unify all changes.
2. In the pull request, provide a description of what change(s) where made 2. Open the pull request against the 'contibuting' branch.
3. In the pull request, add the text: `Fixes:` followed by the URL of the open Issue 3. In the pull request, provide a description of what change(s) where made
- Add the text: `Fixes:` followed by the URL of the open Issue
eg: Fixes: https://ChuckPa/PlexDBRepair/issues/12 (if we were fixing issue 12) eg: Fixes: https://ChuckPa/PlexDBRepair/issues/12 (if we were fixing issue 12)
4. Adding the above text+http tag has the following impact: - Adding the above text+http tag has the following impact:
- The Issue which prompted the change is forever linked to the PR making documentation easy. - The Issue which prompted the change is forever linked to the PR making documentation easy.
- When the PR is approved and merged to master, Github will automatically mark the issue as closed and solved.
5. Be certain to request review with your pull request.
6. Upon completion of review and testing, contributions will be merged into master.
When the PR is approved and merged, Github will automatically mark the issue as closed and solved.
### Policy ### Policy