CONTRIBUTOR.md

Contributor Guidelines

Thank you for considering contributing to the Fitness Tracker API! We appreciate your efforts to help improve the project. To ensure that your contributions are effective and aligned with the project goals, please follow these guidelines.

Getting Started

1. Fork the Repository

Fork the repository to your own GitHub account to make changes. You can do this by clicking the "Fork" button on the repository page.

2. Clone Your Fork

Once you’ve forked the project, clone your copy to your local machine:

git clone https://github.com/YOUR-USERNAME/fitnesstracker.git
cd fitnesstracker

3. Create a Branch

Create a new branch for your work. Always base your branch off the main branch.

git checkout -b feature-branch-name

4. Install Dependencies

Ensure you have Docker installed and set up the project locally by following the instructions in the README.md.

5. Write Tests

If you're making changes to the API, ensure you write unit and integration tests. This is important to keep the project stable.

6. Run Linters and Tests

Before submitting your changes, ensure they follow the project's code style by running linters and tests.

cd scripts
./run-linters.sh

Submitting Contributions

1. Commit your changes

Write clear and descriptive commit messages. Your commit messages should be short and concise, summarizing the changes.

git commit -m "Add feature or fix description"

2. Push to your Fork

Once you’re happy with your changes, push them to your forked repository.

git push origin feature-branch-name

3. Create a Pull Request

Navigate to the original repository, and click the "Pull Request" button. Provide a clear title and description for your pull request.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you agree to abide by its terms.

Need Help?

If you have questions about contributing, feel free to open an issue or reach out to the maintainers.