Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 3.32 KB

Contributing Guidelines

Hello! Thank you for looking on our source code, and even more if you are willing to contribute. In SLC-wms we encourage Open Source practices, that's why we have a Code of Conduct that we'll be glad if you can read before contributing. Also, if you think there is any issue with our software, please take a look con our Security Policy before publishsing anything on Github's Issues.

Anyways, that's enough talk, let's get to the point. You want to participate in our development, right?

Github Issues

In terms of Github's Issues, please use any of our predefined templates, it will make an easier work for the both of us. However, if our templates doesn't match what you are trying to tell us, then try your best to be clear, even if it takes many words, we prefer a better explanation than doing it fast, but if you can provide both, we'll be happy to help! Finally, please look for your found issue in our open issues, if it's already reported, then leave a comment, it will light up that the issue require more attention.

Doing a Pull Request

What about Pull Requests? We provide a template on what is the least you shall provide about your contribution, if any of the fields that we set doesn't apply to your contribution, then don't fill it, is okay.

On terms of our conventions, we use Conventional Commits, however, if you want to start fast, we can work with a simple version of just committing like this:

[feat/fix]: [A verb] [What you did] [Any context]
Here are some examples:
feat: Added a scrollbar component on the Billing page
fix: Removed the silent bug on the model's service

And, to finish up, we take in count the Developer's Certificate of Origin, so please read this before helping out, as you are required to accept and follow these restrictions.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


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.