Guide to Contributing

Team Norms

Please make sure that you are following our team norms before making any contributions.

These are the same rules listed in our coding standards.

Don't over-engineer. Write minimum code to get things working end to end, only then iterate to improve.
Always push working code, if you break the pipeline/build then fix it.
Make granular and small commits, per feature or per bug fix.
Provide descriptive commit messages.
Write self documenting code. Use descriptive variable and function names. Avoid unnecessary name shortening.
Don't leave dead/commented out code behind. If you see such code, delete it.
Write automated tests to cover critical integration points and functionality.

To create a copy of this project repository on your own local machine:

Go into the directory that you would like the project folder to be in: cd <directory-name>
Clone the project repository: git clone <url>
Go into your local copy of our project repository: cd final-project-fitnet

Instructions for working on the project are below in the Git workflow section.

To work on this project from your own local machine:

Commit your changes:

git status 
git add <changed-files> 
git commit -m “<a descriptive message about the changes you made>"

Push your new branch to the remote repository: git push origin <branch-name>
Make a pull request to merge your new branch with origin/main. Please leave a polite message detailing your changes.
If new changes have been merged, bring your local repository up to date in the main branch:
```
git checkout master
git pull 
```

To test this project:

The app should start in your default web browser.