Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.

Commit 95b4d2a

Browse files
authored
added an editing conventions subsection
1 parent a1315dd commit 95b4d2a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ A "good" contribution would follow this flow:
77
1. (Sometimes Optional) Create an Issue.
88
1. Prove that what you've created is better than what already exists.
99
1. Create/modify an automated test to guarantee that what you did is not going to break some other thing inside the library.
10+
1. Make sure your code follows this libraries editing conventions.
11+
1. Create a *Pull Request* to an appropriate branch.
1012

1113
## First Things First: Create an Issue
1214

@@ -36,6 +38,12 @@ There are already quite a lot of tests in this library. However, nothing guarant
3638

3739
Additionally, if it were me, even if there already exists a test covering my code, I might end up writing a custom one — or mentioning the name of the existing one — in my `benchmarks` file anyway, just for the sake of documentation.
3840

41+
## Editing Conventions
42+
43+
For the most part, this library follows [`PEP 8`](https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds) conventions. Try to follow them when contributing. If you find code inside this library that does not respect those conventionse, please do create an issue and we will try to fix it. It's usually straight forward to fix it and it avoids a lot of pain in the long-term.
44+
45+
It is also crucial that you follow [`Numpy's Docstrings`](https://docs.scipy.org/doc/numpy/docs/howto_document.html) conventions when creating or editing `docstrings`. They are a subset of [`PEP 257`](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
46+
3947
## Version Control
4048

4149
Except in some cases — like better Documentation — this library uses [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), i.e., most content will first be buffered inside a `dev` or `feature` branch before being merged into the `master` branch.

0 commit comments

Comments
 (0)