Skip to content

Commit 6d20899

Browse files
realDuYuanChaogithub-actions
andauthored
Added CONTRIBUTING.md (#18)
* reverse string * Formatted with psf/black * remove whitespace * Formatted with psf/black * format code * Formatted with psf/black * add contribution Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
1 parent b75b63a commit 6d20899

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing guidelines
2+
3+
## Before contributing
4+
5+
👏👏 Welcome to [examplehub/Python](https://github.com/examplehub/Python) ! Before sending your pull requests. Please make sure that you **read the whole guidelines**.
6+
7+
## Contributing
8+
9+
#### How to contribute
10+
1. Fork the project to your github account & clone locally computer.
11+
2. Create an upstream remote and sync your local copy before you branch.
12+
3. Branch for each separate piece of work.
13+
4. Do the work, write good commit messages, and read the `CONTRIBUTING.md`.
14+
5. Push to your origin repository.
15+
6. Create a new PR in GitHub.
16+
7. Waiting to be review by the maintainers.
17+
18+
#### Code Style
19+
20+
#### Code Style
21+
* Please follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) Coding Style.
22+
* Single letter variable names are old school so please avoid them unless their life only spans a few lines.
23+
* Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
24+
* Write `test unit` to test all your functions.
25+
* [More details](https://docs.python.org/3/tutorial/controlflow.html#intermezzo-coding-style) about Code Style.
26+
27+
### Thanks for your contribution 😊

0 commit comments

Comments
 (0)