BoostNote-App/CONTRIBUTING.md
Olawale Oyeyipo ad1fd60a4e Add a development workflow section
This links to the already already available documentation at
`docs/development.md`.
2021-10-18 20:53:25 +09:00

1.3 KiB

Contributing to Boost

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to rokt33r.choi@gmail.com.

The following is a set of guidelines for contributing to Boost. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submitting Issues

  • Before creating an issue please read the notes below and include as many details as possible with your report. You can create an issue here. If you can, please include:
    • The version of App you are using
    • The operating system you are using
    • If applicable, what you were doing when the issue arose and what you expected to happen
  • Other things that will help resolve your issue:
    • Screenshots and animated GIFs
    • Error output that appears in your terminal, dev tools or as an alert
    • Perform a cursory search to see if a similar issue has already been submitted

Development workflow

To setup and run BoostNote locally, checkout our development doc to help you get started.