Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 3.49 KB
Raw

Contribution

Before working on the project it's very important to understand its value and how it works. You can find that information in the project Documentation (either in the README file or in the project Wiki). All Caramba projects respect the CODE OF CONDUCT. Keep it present when contributing with the project. If any of the principles listed there is not followed we'll be forced to take action on that.

A note for developers

Are you interested in contributing? Just do it! Caramba projects are also your projects. We created them for the community and you are part of that community. We're open to new contributors, proposals, improvements, bug fixes... If you are a very active contributor we'll also add you as a member of the repository.

We're looking forward to your contributions!

Moderating

If you are moderator in any of our projects:

  • When new Issues/PRs are opened we should check if they are in the scope of the project. In case they aren't we should politely explain why, suggesting alternatives, and clossing them.
  • To have a better organization we should tag the Issues/PRs as they get created. Include a label for the type and the severity & occurence (in case of a bug).
  • If some information is required to have a better context about the Issue/PR we should ask the developer for it.
  • If the Issue/PR doesn't follow the Coe of Conduct. We should close the Issue/PR right away.

Issuing

If you are a developer using the project and you are interested in reporting an issue:

  • The issue body will be automatically filled with a template. Fill the template information describing your issue and providing some context.
  • Project moderators might ask you for for some information. Be willing to report it.
  • Use a descriptive name for the Issue.
  • The reported Issue must follow the Code of Conduct.

Coding

If you contribute with the project make sure:

  • Your changes in the project follow the project architecture and style.
  • Make sure you include unit tests for your changes and they pass.
  • Make sure you get all the GitHub validations passing.
  • The code is docummented.
  • The CHANGELOG is updated to reflect the changes.
  • If needed, the README includes a quick reference to the changes.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Wording of statement copied from elinux.org