Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.87 KB

Why do you want to contribute?

There is a bug

Something does not work on the website...

  • If you have ideas how to fix it and you are interested to give it a try, feel free to fork the repo and to do so! Your pull requests are welcome.
  • You can also inform us about the bug by creating an issue with a label "bug".

Suggesting Enhancements

The website is functioning properly, there is no bug. But you think that something still can be improved. Then, please share your ideas by creating an issue with a label "enhancements".

How can you contribute to Readeer?

Pull Requests

  • Fork the repo and create your branch from master.
  • Install all dependancies. check out Readme
  • If you've changed APIs, update the documentation.
  • Git Commit Messages: that would be nice to see small well-named commits. But no one is perfect.
  • Make sure your code lints. You can try running npm run lint for style unification.
  • Give your PR a clear and descriptive title.
  • Describe in the commentary: a problem and the way you solved it.
  • Send a pull request.

Issues

  • Please give your Issue a clear and descriptive title.
  • Describe a problem as precisely as possible.
  • If it is a bug report, describe us steps to reproduce the bug.
  • Add an appropriate label (bug, enhancements, question etc.)

Documentation Styleguide

Please use Markdown in your PRs and issues.

Code of conduct

Please consider that in this project we stick to a standard Contributor Covenant Code of Conduct.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Learn more about the project

To learn more about the project read our wiki.