Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.48 KB

Contributing to this repository

So you want to contribute? Yay! Great! Fun! we love seeing new PRs our community portal. That being said, not every pull request will be merged. The general guidelines we'll follow are:

  • Does it make developing the TechTank community portal easier?
  • Are you doing a PR into the development branch?
  • Does it fix a bug?
  • Does it break anything?
  • Does it stick to the original goal of the TechTank community portal?
  • Does it reduce the build size?
  • Is it necessary?

Regarding PRs into development, please make all PRs into the development branch because the main branch is reserved for production. Further, we don't expect all pull requests to be absolutely necessary. New features are good, however, if the new features make the bot unnecessarily complex in some way without bringing value to the community, it won't be merged.

Ready to contribute?

  1. Create a fork of the repo
  2. Create a new branch using the format below
  3. Work on your fork, then open a pull request
    1. When opening a PR, the title of the PR should follow this example -> [TCP-23] Feat: adds dropdown menu
  4. Your PR will be reviewed, and if it is approved it will be merged into development

What to call your newly created branch

Create a new branch with the keyword of what you are planning to do. For example, if you're planning a new feature then the branch name may look like feat/TCP-1. However, if you're adding a new test then the branch name may look like test/TCP-23.