search

ASU-CodeDevils / devilbot

A Rust rewrite of Flameboi to work for our Discord Server.
Apache License 2.0
16 stars 1 forks source link

Add Contribution / Git Workflow Section to README.md #8

Closed jtmichelson closed 2 years ago

jtmichelson commented 2 years ago

Standardize the contribution process for this project.

  1. All PRs related to issues should have the first line of their body/description include the resolves keyword and what issue it is meant to resolve (e.g. Resolves #2 to resolve issue #2). This auto-links the PR to the issue.
  2. Assign at least 1 other reviewer to your PR and get explicit approval before merging (See issue #7).
  3. Put clear descriptions in PR bodies to help the reviewer understand all context of your changes. Adding testing details if required.
  4. Add an overview of how to do a simple Git workflow for creating a pull request with a new branch for new contributors that may not have used Git before.
  5. Brainstorm any other standards.
jtmichelson commented 2 years ago

Add README info on how to add new commands, what files to create, what modules to declare, and what example event bodies look like.