Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Contributing guideline update #83

Merged
merged 1 commit into from
Jan 20, 2022
Merged

DOC: Contributing guideline update #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Thank you for taking the time to contribute!

We can't think of everything. If you've got a good idea for a feature, then please let us know!

Feature suggestions are embraced, but will often be filed for a rainy day. If you require a feature urgently it's best to write it yourself. Don't forget to share ;)
Feature suggestions are embraced, but will often be filed for a rainy day. If you require a feature urgently it's best to write it yourself. Don't forget to share :)

When suggesting a feature, make sure to:

Expand Down Expand Up @@ -51,6 +51,7 @@ Once you're ready to share your contribution with us you should submit it as a P

#### Do

* Do use our own internal logging [API](https://github.com/royerlab/aydin/blob/master/aydin/util/log/log.py)
* Do use pep8 style guidelines + our preferences with `black` formatter
* Use NumPy style docstrings
* Do comment your code where necessary
Expand All @@ -60,7 +61,7 @@ Once you're ready to share your contribution with us you should submit it as a P

#### Don't

* Don't include any license information in your examples- our repositories are GPLv3 licensed
* Don't include any license information in your examples- our repositories are BSD-3-Clause License d
* Don't try to do too much at once- submit one or two examples at a time, and be receptive to feedback
* Don't submit multiple variations of the same example, demonstrate one thing concisely

Expand Down