Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 2.39 KB
Raw

Contributing to Spok

Thank you for your interest in contributing to Spok! We want to encourage you to contribute with documentation, bug reports, code and ideas.

Before contributing, please read our Code of Conduct and License.

Table of Contents

Documentation

The project uses the RDoc tool to generate documentation. Spok uses the TomDoc style for writing docs. You can read the existing docs for more information.

Documentation is a very important portion of software. We want to always improve our communication using it.

Did you find a bug?

  • Ensure the bug was not already reported by searching on Issues page.

  • If you're unable to find an open issue addressing the problem, open a new one. Please, be sure to include a title and clear description, as much relevant information as possible.

Contributing with code

To contribute with code you should follow these steps:

  1. Fork the project;
  2. Clone your fork using the project URL (git or https);
  3. Create a new branch to implement your functionality or code. This can be done with the command: git checkout -b your-branch-name-here;
  4. Make your changes and add a new commit with a clear message saying why this change is being made;
  5. Make sure the tests are passing. To run the tests use the command: rake spec;
  6. Push your code with the command: git push -u origin your-branch-name-here;
  7. Go to your fork page at Github;
  8. Open a new Pull request.

If you want ideas on what you can do, check the open issues.

Contributing with ideas

To contribute with ideas you can open a new issue. Please write a clear description of your suggestion, along with motivations and examples.

Do you have questions about the source code?

Thanks! ❤️ 🎉

Magnetis Team