Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 2.39 KB

Contributing

Roar was built with love by a group of digital activists from different backgrounds and levels of experience. We appreciate you for wanting to help. There are plenty of issues and anyone can contribute.

If you want to help by resolving an issue, we encourage you to look at the list of "good first issue" issues. These issues will help you get your feet wet and get familiar with our codebase.

If you want to open a bug, please open a new issue with the following details:

  • A short description of the bug. e.g. "Can't upload an image".
  • Details about your setup - extension version, server version, chrome version etc.
  • What actually happens. e.g. "When uploading a new PNG image, the extension crash".
  • What you expect to happen. e.g. "When uploading a new PNG image, the extension should display the new image".
  • Steps to reproduce the bug. Screenshots and short videos can help us identify and solve the bug and they'll be greatly appreciated.

If you want to add a small feature or change request, feel free to open a Pull Request. We can't promise we will merge every feature, but as long as it adds value and follow our guidelines we will happily consider it. If the want to add a big feature or change request, or you're not sure how to implement it, feel free to open a new issue and the core team will review it. You can also join our Slack workspace and discuss your issues with us.

All Pull Request should pass our linter (run npm run lint) and current tests (run npm test). Before submitting a Pull Request, please make sure to add relevant tests and documentation to the README.md if needed.

How to Contact Us

Our team is very active here on GitHub and on our Slack workspace.

Code of Conduct

Roar is part of More Human Internet. Our purpose is to build a free, public platform that facilitates dialog between the users and maintainers of the web to promote civility, transparency, and the greater good. We expect everyone to read and follow our Code of Conduct