CodingPirates/pyscrlink
1
0
Fork 0
mirror of https://github.com/kawasaki/pyscrlink.git synced 2025-07-21 09:31:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Shin'ichiro Kawasaki
2020-08-08 12:04:20 +09:00
committed by GitHub
parent 3a68a0109e
commit cc3d88eb51
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,18 @@
Contributions to the project are always welcome!
Though there is no strict rule on how to contribute, following points will help to merge your changes smoothly.
(Some of them are quote from Linux patch submit guide. :)
CODE
----
- Separate commits so that each comit has single purpose: it is good to separate "bug fix", "new feature" and "spelling fix".
- The preferred limit on the length of a single line is 80 columns.
COMMIT MESSAGE
--------------
- Write short description in the first line with format "CHANGE_TARGET: SHORT_CHANGE_DESCRIPTION",
e.g. "BLESession: Support multiple Bluetooth adapters" or "BLESession.matches: Support namePrefix
in matching filters".
- Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
to do frotz", as if you are giving orders to the codebase to change
its behaviour.