Issues and Projects - ntjoar/Munchy GitHub Wiki

All of our assignments remaining will be stored in two tabs above: "Issues" and "Projects"

Issues

This tab will primarily be used to discuss issues, generate new ones, and push them to our "Projects" tab. Although there are ways to generate cards in the "Projects" tab, this tab will keep a master list for everyone to see.

How do I create an issue?

  1. Go to the "Issues" tab
  2. Click on "New Issue"
  3. Give a short title giving us an idea of what the issue is
  4. Give a longer description comment. Explain everything, whether the issue is a bug or a new feature, or a change to structure request. Explain how to recreate the bug or what the new feature is as if you were explaining it to someone that doesn't even know what we are working on
  5. Add labels corresponding to the feature (see Labels below)
  6. Add it to the correct Projects folder that corresponds to the team that will be dealing with those files. This will let the team know this issue is ready to be hit
  7. If you are a developer, feel free to even assign yourself the issue if you feel comfortable working on it
  8. Click "Submit new issue" when done
  9. If at any point, you are unsure, ask a manager to assign labels, projects, or even people to the issue. Tell us if the issue is absolutely urgent and needs to be fixed immediately

Projects

In the "Projects" tab, you will see two projects. These projects are open but requested that you work only on the teams that you are assigned on. Some notes on the projects tab:

  • For any issue, you can click on the issue and in the right bar there will be a button for "Go to issue for full details"

This gives you more details to any issue that you would want details to

  • If you assign yourself on an issue, move it into "In Progress"
  • Once a PR has been generated, move your issue into "Review in progress"

From here on out, you will not touch that card unless you are a reviewer

  • Reviewers: Once you have reviewed and approved the PR, move the card into "Reviewer Approved"

Labels

Labels help us organize what type of issues they are. They're even color-coded to make it easy for developers to identify what type of issue it is. The descriptions are given below:

  • backend: Backend development issue
  • frontend: Frontend development issue
  • bug: Something isn't working
  • documentation: Improvements or additions to documentation
  • duplicate: This issue or pull request already exists
  • enhancement: New feature or request
  • invalid: This doesn't seem right
  • question: Further information is requested
  • repo: GitHub Repository Upkeep
  • wontfix: This will not be worked on

See also: Branches

See also: File Heirarchy

A helpful tool: Fork