Contributing

Git Flow

The project will follow GitHub Flowarrow-up-right. The essential rules are as follows.

  • NEVER commit directly to the main branch. Always create a branch with a descriptive name like apply-lint-to-project.

  • Open a Pull Request to merge the branch into the main branch.

  • All code in the main branch should be working, deployable code.

Pull Request and Issues

Whenever working on something, always create a issue and a pull request.

https://github.com/chat-as-a-service/general-api/pull/1arrow-up-right is a good example.

Keep pull requests simple and short. This makes it easy to review. For example, each pull request can be a feature like account signup.

Last updated