Contributing Guidelines - sarayu-pr11/team-narks GitHub Wiki

This is the official page for guidelines regarding pushing, pulling, and merging. We want our github experience to be as efficient as possible so following these guidelines will be crucial.

  1. You must always update your code before committing something new. This prevents conflicts while pushing in Github.
  2. You must only commit the files you want to push at the moment. Don't commit every file you changed at a time in order to prevent errors from being sent to Github.
  3. You must comment out code that you don't want running so that so errors are shown up in another person's code.
  4. You can commit as many times as needed, but only push the code when you are certain it is working and error-free.
  5. Eventually, once the GitHub becomes crowded with frequent commits and pushes, branches will be made and requests to edit the main github will be necessary.
  6. When committing something crucial to the project, make sure to receive confirmation from other team members so that no ones code is overridden or changed.
  7. When adding files to webpages (.png, .jpg, etc.), make sure the file is present in repository by adding it to /static/assets so that everyone has access to the file.
  8. Once the branches are created, requests to add code to the main repo will be necessary.

Branching Procedure We will branch the github when our commits become more complex: To branch our repository, follow these instructions https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches

  1. Click Current Branch
  2. Click New Branch
  3. Under name type the name of the new branch
  4. use the drop-down menu to choose a base branch for your new branch
  5. click create branch

By following these guidelines, you will contribute to a efficient workspace and stress-free repository! -Team NARKS