Contributing Guidelines

Thank you for your interest in contributing to Cancer Detective!

Branches

The main branch is the main branch of this project. It contains the stable and production-ready code.
The develop branch is the development branch for us. It is where new features and bug fixes are implemented and tested before being merged into the main branch.

When making commits to this project, please follow these best practices:

Use a keyword at the beginning of your commit message to indicate the type of change you are making. Some common keywords include:
- add: for adding new features or files
- fix: for fixing bugs or issues
- update: for updating existing code or documentation
- remove: for removing code or files
Separate the keyword from the message with a colon (:).
Write a clear and concise message that describes the purpose of your commit.

For example, a commit message could look like this:

add: Implement user authentication feature

To contribute to this project, please follow these steps:

Clone the repository to your local machine.
Create a new branch from the develop branch for your changes.
Make your changes and commit them following the commit best practices mentioned above.
Push your branch to the remote repository.
Open a pull request from your branch to the develop branch of this repository.
Provide a clear description of your changes in the pull request and wait for the code review.

Thank you for your contributions!