Skip to content

Github Guidelines

Jump to bottom
arushi10 edited this page Dec 2, 2021 · 1 revision

Management Plan

Detailed Contributing Guidelines on Google Docs

How have you started your GitHub project?

We have started our Github project by creating a README and multiple files (main.py, image.py, starter.py, etc.) and folders (static and templates folders) to organize our code. We have also started committing basic changes to our website.

Here is our current Github page

Did you create a .gitignore to avoid committing files that don't belong in version control?

Yes, I have created a .gitignore file for my team’s repository, in order to avoid committing files that don’t belong in version control.

Our .gitignore file

Did you make sure NO .idea files are in your GitHub repository?

Yes, I made sure that there are no .idea files in my GitHub repository.

How do you manage commits to avoid problems?

  • Before making a commit, make sure that you are not pushing any *.idea files in the .gitignore file
  • Make sure you have pulled all previous changes before committing
  • Run your changes locally to make sure that they do not cause any problems* before you commit
  • Commit after you have changed multiple tested items
  • Write a description of the commit when committing

Have you considered branching techniques with pull requests?

  • If you would like to make changes to the website, first branch the code (especially necessary when you are working on a new feature).
  • Make your changes to the branched code.
  • Make sure the code runs properly.
  • Make a pull request and add a summary of the proposed changes. In a pull request, you can also review the changes made by commits, add labels, milestones, assignees, and mention individual contributors.

What actions will you take this Trimester to get better at managing merge or commit problems?

This trimester, our team will follow these guidelines carefully. We will be sure to reduce the frequency of our commits and run them locally before pushing. If we are working on a new feature, we will branch the code and make a pull request. When the pull request is approved, it will be merged into the overall code.

Clone this wiki locally