When bringing people on as contributors we prefer that they start with an issue tagged good first issue.
After a contributor has shown they're a good fit and have completed 1 or 2 issues labeled good first issue with pull requests that have been accepted, feel free to move on to other issues. We welcome new contributors.
If you want to better understand how the development process works, please refer to our as yet unwritten wiki pages.
In order to get the repositories setup before contributions refer to the README.md file.
-
Find a suitable issue
If this is your first time look for an issue labeled good first issue otherwise look for issues labeled help wanted . If another issue jumps out at you please engage on the issue before starting it.
-
Assign yourself the issue
Let us know you're working on it! We hate wasted labour so it's always helpful to know what our community contributors are working on.
-
Fork and clone FundItETC
In general it's a good practice to fork into your own repository. We prefer if issues are addressed in a branch with the issue number in its name. i.e.
29_this_is_an_issue
-
Make contributions
Make all the changes needed to address the given issue.
-
Add testing
In general we aim for full test coverage. For this reason most issues completed should include full testing. If you think there should be an exception for your issue please reach out.
-
Run previous tests
Make sure that the changes that you've made don't break anything! Ensure that running
npm test
andnpm eslint
doesn't throw any new and unexpected errors. -
Push all your work
At this point the issue should be addressed, new testing should be in place, and all old tests should be passing.
-
Create a Pull Request
At this point you should have a forked repository with your issue fixes and it is time to put in a PR. Make sure that your PR has something like
addresses #26
orcloses #26
The most important thing is that it has the relevant issue number referenced in the body of the PR. -
Make noise!
Get in our Discord and point to your new PR. Let us know you've tackled your first, third or 90th issue with us. We'll review it and everybody will get a warm feeling of accomplishment.
-
rinse, repeat
Find another issue, get more involved, make noise in our Disord, or find issues we may have missed. You've completed your first step to becoming a contributor. You're helping to Decentralize the FUTURE!
If you still have any questions about contribution feel free to reach out.