Skip to content

Latest commit

 

History

History
43 lines (21 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

43 lines (21 loc) · 2.51 KB

CONTRIBUTING

New Issue

Before reporting an issue related to RosarioSIS, please consider the following recommendations:

  1. Search the closed issues or the Wiki, your problem may already have been answered. Please do not create duplicates.

  2. Specify your RosarioSIS, PHP & PostgreSQL versions, along with the server & browser used.

  3. Provide steps to reproduce the problem.

  4. Attach a screenshot.

  5. RosarioSIS errors, bugs (PHP, SQL, JS errors) & design or logic errors are welcome.

  6. Installation problems: RosarioSIS has been succesfully installed on various environments; nevertheless, you may encounter errors specific to your OS, PHP or PostgreSQL version or configuration. For the same reasons, installation problems will likely not be solved here.

  7. RosarioSIS use: the Handbooks, the inline Help & the Wiki contain useful resources to help you get the most out of RosarioSIS. For all your questions about RosarioSIS use and school administration, you can discuss them in the forum.

  8. Email support: to get professional help with installation problems, or RosarioSIS configuration, please head to https://www.rosariosis.org/services/

You have PHP web development skills? Please head to the next section & send a pull request.

Contributing to RosarioSIS

Please head to the offical Contribute page to learn about how you can contribute to the project.

Coding standards

  1. We roughly follow the Wordpress Coding Standards.

  2. Comment your code: we use PHPDoc.

  3. Quality Assurance: we use code linters & other QA tools

  4. Testing: Activate debug mode; for emails, we use MailCatcher

Example Module

Freely study and reuse the Example module