Update CONTRIBUTING.md to match #964 (#969)

* Update CONTRIBUTING.md to match #964

Blocked by #964

* Do not modify README or DIRECTORY file.

* Update CONTRIBUTING.md
This commit is contained in:
cclauss 2019-07-08 17:38:47 +02:00 committed by John Law
parent b7f13d991c
commit 78cd3df3fc

View File

@ -28,6 +28,13 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im
We want your work to be readable by others; therefore, we encourage you to note the following:
- Please write in Python 3.x.
- Please consider running [__python/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not a requirement but it does make your code more readable. There are other code formatters (autopep8, yapf) but the __black__ style is now the recommendation of the Python core team. To use it,
```bash
pip3 install black # only required the first time
black my-submission.py
```
- All submissions will need to pass the test __flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics__ before they will be accepted so if possible, try this test locally on your Python file(s) before submitting your pull request.
- If you know [PEP 8](https://www.python.org/dev/peps/pep-0008/) already, you will have no problem in coding style, though we do not follow it strictly. Read the remaining section and have fun coding!
@ -74,11 +81,17 @@ We want your work to be readable by others; therefore, we encourage you to note
The following "testing" approaches are **not** encouraged:
```python*
```python
input('Enter your input:')
# Or even worse...
input = eval(raw_input("Enter your input: "))
```
However, if your code uses __input()__ then we encourage you to gracefully deal with leading and trailing whitespace in user input by adding __.strip()__ to the end as in:
```python
starting_value = int(input("Please enter a starting value: ").strip())
```
Please write down your test case, like the following:
@ -92,8 +105,10 @@ We want your work to be readable by others; therefore, we encourage you to note
print("1 + 2 = ", sumab(1,2)) # 1+2 = 3
print("6 + 4 = ", sumab(6,4)) # 6+4 = 10
```
Better yet, if you know how to write [__doctests__](https://docs.python.org/3/library/doctest.html), please consider adding them.
- Avoid importing external libraries for basic algorithms. Use those libraries for complicated algorithms.
- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
#### Other Standard While Submitting Your Work
@ -105,15 +120,17 @@ We want your work to be readable by others; therefore, we encourage you to note
- If you have modified/added code work, make sure the code compiles before submitting.
- If you have modified/added documentation work, make sure your language is concise and contains no grammar mistake.
- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
- Update the README file if you have added any new algorithm. Only entry corresponding to the algorithm is to be made, not need to add sample data, test files or solutions to problems like Project Euler, in the README.
- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes.
- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
- All submissions will be tested with [__mypy__](http://www.mypy-lang.org) so we encourage to add [__Python type hints__](https://docs.python.org/3/library/typing.html) where it makes sense to do so.
- Most importantly,
- **Be consistent with this guidelines while submitting.**
- **Be consistent in the use of these guidelines when submitting.**
- **Join** [Gitter](https://gitter.im/TheAlgorithms) **now!**
- Happy coding!