Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.65 KB
Raw

Contributing to Pomotroid

Thank you so much for contributing to Pomotroid. We appreciate your time and help. Here are some guidelines to help you get started.

Code of Conduct

Be kind and respectful to the members of the community. Take time to educate others who are seeking help. Harassment of any kind will not be tolerated.

Questions

If you have questions regarding Pomotroid, feel free to open an issue with the Question tag, or reach out directly via email at [email protected].

Filing a Bug or Feature

  1. Before filing an issue, please check the existing issues to see if a similar one was already opened. If there is one already opened, feel free to comment on it.
  2. If you believe you've found a bug, please provide detailed steps of reproduction, the version of Pomotroid and anything else you believe will be useful to help troubleshoot it (e.g. OS environment, environment variables, etc...). Also state the current behavior vs. the expected behavior.
  3. If you'd like to see a feature or an enhancement please open an issue with a clear title and description of what the feature is and why it would be beneficial to the project and its users.

Quick Steps to Contribute

  1. Fork the project.
  2. Download your fork to your PC (git clone https://github.com/your_username/pomotroid && cd pomotroid)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Ensure project runs and builds successfully (npm run dev) and (npm run build)
  5. Add them to staging (git add .)
  6. Commit your changes (git commit -m 'Add some feature')
  7. Push to the branch (git push origin my-new-feature)
  8. Create new pull request to the dev branch.