Skip to content

Create contributing.md #8

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create contributing.md #8

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
15 changes: 15 additions & 0 deletions doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
How to contribute

For any contribution you had in mind, please open a detailed issue on what you are contributing and why. This way, there can be room to have a productive discussion before any code is written. It can be discussed if the contribution is a good fit for this project, fine tune contribution goals, and more.
Feel free to drop into the 100 Automations slack to reach out to me to ask any questions.

Testing
As of right now, there are no concrete testing practices. Tests on any further development will be implemented are done using pytest. If you would like to contribute, it would be best to use jest so that the project isn't dependent on multiple testing libraries.

Submitting changes
Please fork this repository and create a Pull Request to this project from that fork (How to fork a repo). In that pull request, please include thorough tests for whatever feature you are adding. If you would just like to submit more or better tests for currently existing features, that would also be much appreciated and helpful.
Please only add one feature per pull request and have clear commit messages in them.

Coding conventions
Please add code in a similar style/fashion to how code is currently written.
Thank you for being interested in contributing.