How to Contribute

Contributing:

First and foremost, your best bet is to join oneleif via the discord on the Homepage. From there, head over to the issues tab to see what needs to be worked on. If you feel comfortable doing something, assign yourself to it!

You can see our general direction and goals in the goals and roadmap section.

Process:

Beginners:

1. Clone the repo to your machine
2. Read the README (derp) for installation instructions. It is important you follow all the installation instructions for the project to run.
3. Pick an issue to address (or if you'd like to add something not tracked, feel free!) and create a branch to hold your proposed changes: git checkout -b feature/NAME where NAME is a suiting name for your changes
4. Make your changes (Make sure it doesnt break anything~~) and push your branch to the repo

• Add all of your changes by using git add -A
• Stage your changes in a commit: git commit -m "MESSAGE" where MESSAGE describes your changes in a few words
• Push 'em up using git push and type in your github credentials!

5. Create a Pull Request to merge your branch with develop

• Make sure to add 2 reviewers; this can be @yudjinn, @ambid17, or @0xLeif if you arent familiar with the code owners

6. Once the reviews are done, and any corrections have been made, click "Merge" then click "delete branch"

• Back on your local repository, now that the branch is deleted, make sure to git checkout develop to switch back to the main branch, then git branch -d feature/NAME (name of branch) then git pull to pull your changes that have been merged!

There ya go! Thats the whole process!

Experienced:

Our main branch is develop, and you should branch from that. Our format for changes is feature/NAME where NAME is a suitable name for your changes. Pull requests require 2 reviewers, of which the main choices would be @yudjinn, @ambid17, or @0xLeif; make sure to assign yourself to the PR so we don't get competition.

Thanks for joining the community and contributing to oneFit!