Browse Source

更新 'CONTRIBUTING.md'

天问 9 months ago
parent
commit
9c86c2fbdc
1 changed files with 12 additions and 1 deletions
  1. 12 1
      CONTRIBUTING.md

+ 12 - 1
CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to github-actions-creator
+# Contributing
 
 :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
@@ -28,6 +28,17 @@ Do not add your issue as a comment to an existing issue unless it's for the iden
 
 The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
 
+
+## Pull Requests
+
+When creating Pull Requests, follow the most [common good practices](https://gist.github.com/MarcDiethelm/7303312), 
+respect the swiftlint static checks (modifications/exceptions may be discussed), and create an awesome description so 
+we can understand it without asking any whys.
+
+## Commit Messages
+
+Commit messages matter. Aim to be succinct and descriptive at the same time. We consider as a good source 
+[How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) from Chris Beams.
 # Thank You!
 
 Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.