How to get started working on the project? - csinn/CSInn GitHub Wiki

Issues

All of our tasks are placed here. If you think you can do a task- assign yourself to it. When you start working on the task don't forget to move the issue from "To Do" to "In Progress".

Git Flow

When you start working on a task, create a new branch from the dev branch. Make some changes. Commit, push. When you are finally done, create a pull request. Request to merge from your new feature branch to dev branch. When we want to go to production, we merge the dev branch with master. Your changes will be accepted after 2 other members reviews your code. Your changes might be rejected, then based on the comments you will have to make some changes.

Branch naming guidelines

master- main branch. This branch will be in production.

dev - in development branch.

feature/feature-name- new task branch. Whenever you work on a new thing, create a branch with such name.

bug-fix/fix-name- for fixing a bug, a new branch should also be created.