Contributing

Commit Policy

  1. Multiple people should not be adding code to or working on the same file at the same time. If this happens you might get even more errors, ultimately leading one person's code to get erased or break
  2. Do not change the formatting of (reorganize) any existing folders or files without prior discussion
  3. Make sure that you have first pulled and merged before making a commit. Otherwise you might get an error to clean your VSCode repository and you won't be able push and pull Don't push the Gemfile
  4. Do not commit files that you don't remember changing or files with broken code.
  5. Make sure to resolve any conflicts when you pull or push Otherwise these errors will be transferred over to others' code too if they pull
  6. If you do need to commit code with some problems, save it to a separate branch instead of the master.
  7. If you are trying to test code in the same repository that is causing problems, transfer to a new branch to test locally
  8. Each main feature should be worked on through a separate branch designated for that feature. All commits regarding that feature should be made only to that branch.
    • Branches should only be used for large project features (don't make a new branch for cb work or about pages unless necessary)
    • When that feature is completely working, you must create a pull request that will be reviewed before merging the branch with the master

Making Commits

  1. Always commit after each small change so that you are able to be more specific with your commit messages and no problems are caused
  2. Try to make each commit focused on a specific feature. Break apart large commits based on those specific features.
  3. Make sure all of your commmits have clear descriptions that explain the changes made
    • When updating the ReadMe, include a description when making significant changes.
  4. You should be aiming commit your working code each day after or during class. Check insights on GitHub!

Cloning a Repository

  1. Go to the repository in Github and to the code tab
  2. Select the green code button and make sure you are in the HTTPS tab
  3. Copy the link
  4. Go to VSCode (make sure you are in WSL if on Windows) and select the clone a repository on the homepage and paste the link to clone

How to Commit and Pull

  1. To commit, go to the source control tab on the left hand side and press commit, making sure to write a descriptive commit message
  2. To pull, go to the bottom of the screen and press the circle of errors which will pull any commits made (that were pushed) from other devices