Skip to content
This repository has been archived by the owner on May 29, 2019. It is now read-only.

Latest commit

 

History

History
executable file
·
45 lines (26 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
45 lines (26 loc) · 1.81 KB

Contribute To Siberian

Anyone can contribute to Siberian. And we need your contributions.

There are multiple ways to contribute: report bugs, improve the docs, and contribute code.

Submit An Issue

  1. Search into existing issues before submitting yours
  2. Fork the Github repo: git clone https://github.com/Xtraball/Siberian.git
  3. Create a new branch from master: git checkout -b issueid-shortdescription
  4. Review our pull request guidelines.
  5. Follow our coding conventions.
  6. Test your code so it won't break any feature`
  7. Submit a pull request!

Help Improve The Docs

Our documentation is hosted on github too, and will grow with new features, help us improve it the same way.

If you found a typo, make a tutorial or have a better way to describe our documentation, fork it !

Fork the Github repo: git clone https://github.com/Xtraball/SiberianCMS-Doc.git

We use MkDocs to generate the docs, so every page is written in Markdowns

Share new features

If you have developed, who are aiming to develop new features to share with the SiberianCMS community you are welcome.

We wrote a complete documentation on how to create new modules

Pull Request

Keep your pull requests as small as possible, bundle only one feature or bug fix per pull request, it is also easier for us to test single bug fixes

Conventions

We try to follow the PSR-1 standard as much as possible, and to keep our code clear and understandable, that's all !

  • Comment every portion of code you think could be hard to understand.

License

By contributing your code, you agree to license your contribution under the OSL license.