Project Freezer Burn

This is a collaborative project by the Norse IoT club.

The project goals and deliverables are outlined at https://scrum.norseiot.club/project/1/overview.

Our collaborative scrum board is available at https://scrum.norseiot.club/board/1.

Feel free to discuss this project on Discord.

Contributing

This is the general workflow to make a contribution to this repository:

1. Clone the repository
   • If you've already cloned the repository, it helps to do pull the most recent changes (e.g. git checkout main && git pull) to reduce conflicts when you merge your feature.
2. Make a feature branch
   • Every feature you develop will be coordinated in a "feature branch", so that features may be developed independently.
   • We will name all features "feature/your-feature-name" (all lowercase, kebab-case) to distinguish features from hotfixes (e.g. hotfix/oops-i-made-a-mistake) and other types of branches.
   • We will merge feature branches directly into main.
3. ⭐ Do your work and make your commits. ⭐
   • When developing, make sure to commit your changes regularly. We can always squash commits later, so don't worry about making too many commits. Do worry about losing work, or making it difficult for others to collaborate because you haven't shared your work.
4. Submit a pull request (PR)
   • After you add changes to a topic branch or fork, you can open a pull request to ask your collaborators or the repository administrator to review your changes before merging them into the project.
5. Request a review for your PR
   • Requesting a review from other contributors ensures that everyone is on the same page, and that others have the opportunity to point out improvements or changes you might consider.
6. (optional) Address any merge conflicts
7. Merge your PR

Example CLI usage

If you're looking to contribute via the git CLI, I've translated the above steps into commands. You can also use a git GUI if that's easier for you.

1. git clone https://github.com/Norse-IoT/FreezerBurn.git (or gh repo clone Norse-IoT/FreezerBurn if you have the GitHub CLI installed)

2.  git checkout main # start feature branches on main
    git pull # start feature branches with the most recent updates
    git checkout -b 'feature/your-feature-name' # create a feature branch

3. # do this as many times as you need:
   git add -A # add all changes
   git commit -m "changed XYZ" # write a good git message

4. git push --set-upstream origin 'feature/your-feature-name'

5. (done from github)
6. (done from github)
7. (done from github)

Thanks! Feel free to reach out if you have any questions.