Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.99 KB
Raw

🛠️ Contributing to shinigami 🛠️

Welcome, contributing to shinigami is easy!

  1. Submit or comment your intent on an issue
  2. We will try to respond quickly
  3. Fork this repo
  4. Submit your PR against main
  5. Address PR Reviews

Issue

Project tracking is done via GitHub issues First look at open issues to see if your request is already submitted. If it is comment on the issue requesting assignment, if not open an issue.

We use 3 issue labels for development:

  • feat -> suggest new feature
  • bug -> create a reproducible bug report
  • dev -> non-functional repository changes

These labels are used as prefixes as follows for issue, branch name, pr title:

  • [feat] -> feat/{issue #}-{issue name} -> feat:
  • [bug] -> bug/{issue #}-{issue name} -> bug:
  • [dev] -> dev/{issue #}-{issue name} -> dev:

TODO

If your PR includes a TODO comment please open an issue and comment the relevant code with TODO(#ISSUE_NUM):.

Submit PR

Ensure your code is well formatted, well tested and well documented. A core contributor will review your work. Address changes, ensure ci passes, and voilà you're a shinigami contributor.

Markdown linter:

mdl -s .github/linter/readme_style.rb README.md

Scarb linter:

scarb fmt

Additional Resources

Thank you for your contribution!