Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (17 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.33 KB

Contibuting Guidelines

Thank you for wanting to help contribute to this project!

Steps

Please take a look at the latest issues and projects to find something you feel comfortable working on, when you begin follow the feature / bug branching method and tie all of your commits to that issue

Example

The steps for working on the bug "Issue #2 - UI Updating Issue":

  1. Create a branch from the development branch calling it "bug/2-UI-Update-Fix"
  • bug/[issue number]-[issue description]
  • OR feature/[issue number]-[issue description]
  1. Make changes in your local branch to fix the issue making sure to tag all commits to the issue and use these keywords to manage the issue's lifecycle
  • "#2 changed ui method call"
  • "#2 updated properties"
  • "closes #2 minor adjustments and code clean up" (NOTE: this commit uses the 'closes' keyword to automatically close the issue when the PR is merged)
  1. Merge any changes from the development branch into your "bug/2-UI-Update-Fix" branch
  2. Submit a New Pull Request on the development branch

Help

If you need any assistance, ping us on Discord