Merge pull request #15 from CyrilBaah/dev

docs: add documentation for contributing

.github/workflows/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+# Fitness Tracker API Pull Request Template
+
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## How to use this PR
+
+Replace '[ ]' with '[x]' to indicate that the checklist item is completed.
+
+You can check the boxes now or later by just clicking on them.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions on how to reproduce this test. Also list any relevant details for your test configuration
+
+- [ ] Unit Test
+- [ ] API Client Test
+- [ ] Other
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] Any dependent changes have been merged and published in downstream modules

.gitignore

@@ -162,4 +162,5 @@ cython_debug/
 file.txt
 configmapexample.yml
 secretsexample.yml
-deploy.yml
+deploy.yml
+.DS_Store

CONTRIBUTOR.md

@@ -0,0 +1,59 @@
+
+# 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:
+```bash
+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.
+```bash
+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.
+```bash
+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.
+```bash
+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.
+```bash
+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](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines). 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.

README.md

@@ -1,5 +1,5 @@
 # Fitness Tracker API
-Fitness Tracker 
+The Fitness Tracker API project is designed to track exercises, nutrition, and workouts, utilizing a Python backend with Django and Postgres for the database.
 
 ## Technology Stack
 - [Python](https://www.python.org/ "python")