Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 1.39 KB

overview.rst

File metadata and controls

21 lines (16 loc) · 1.39 KB
Raw

Overview

Welcome to the project. We're excited you decided to improve Oríon!

Hopefully, by then you should be familiar with our contribution guide and code of conduct. The documentation for developers is organized in the following, easy to read, sections:

  • Getting Started <installing>. Installing the development environment
  • Conventions <standards>. Get familiar with the project's standards and guidelines
  • Testing <testing>. Implementing your changes and how to test your code
  • Documenting <documenting>. Documenting your changes and updating the documentation
  • Continuous Integration <ci>. Get familiar with our continuous integration setup
  • Releasing a new version <release>. How to create and ship a new release

When you're done, don't forget to rebase your changes to the latest version of the develop branch of https://github.com/Epistimio/orion. Then, submit your pull request and ask for a review when the build is passing in the CI.

If you have any question or suggestion feel free to reach out to us by email or by opening an issue.