Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-20 16:15:59 +01:00
Code Releases Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Mickaël Rémond 2018-11-19 13:12:35 +01:00 committed by GitHub
parent d642a9db88
commit 9a351c0aff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -65,18 +65,22 @@ make it easier to understand and categorize the issue.
## <a name="submit-pr"></a> Pull Request Submission Guidelines ## <a name="submit-pr"></a> Pull Request Submission Guidelines
By submitting a pull request for a code or doc contribution, you need to have the right
to grant your contribution's copyright license to ProcessOne. Please check [ProcessOne CLA][cla]
for details.
Before you submit your pull request consider the following guidelines: Before you submit your pull request consider the following guidelines:
* Search [GitHub][github-pr] for an open or closed Pull Request * Search [GitHub][github-pr] for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort. that relates to your submission. You don't want to duplicate effort.
* Create the [development environment][developers.setup] * Create the [development environment][developer-setup]
* Make your changes in a new git branch: * Make your changes in a new git branch:
```shell ```shell
git checkout -b my-fix-branch master git checkout -b my-fix-branch master
``` ```
* Test your changes and, if relevant, expand the automated test suite.
* Create your patch commit, **including appropriate test cases**. * Create your patch commit, including appropriate test cases.
* If the changes affect public APIs, change or add relevant [documentation][doc-repo]. * If the changes affect public APIs, change or add relevant [documentation][doc-repo].
* Commit your changes using a descriptive commit message. * Commit your changes using a descriptive commit message.
@ -102,6 +106,7 @@ restarted.
* If we suggest changes, then: * If we suggest changes, then:
* Make the required updates. * Make the required updates.
* Test your changes and test cases.
* Commit your changes to your branch (e.g. `my-fix-branch`). * Commit your changes to your branch (e.g. `my-fix-branch`).
* Push the changes to your GitHub repository (this will update your Pull Request). * Push the changes to your GitHub repository (this will update your Pull Request).
@ -124,6 +129,10 @@ so before. It's a quick process, we promise, and you will be able to do it all o
You can read [ProcessOne Contribution License Agreement][cla] in PDF. You can read [ProcessOne Contribution License Agreement][cla] in PDF.
This is part of the legal framework of the open-source ecosystem that adds some red tape,
but protects both the contributor and the company / foundation behind the project. It also
gives us the option to relicense the code with a more permissive license in the future.
[coc]: https://github.com/processone/ejabberd/blob/master/CODE_OF_CONDUCT.md [coc]: https://github.com/processone/ejabberd/blob/master/CODE_OF_CONDUCT.md
[stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest [stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest
@ -134,4 +143,7 @@ You can read [ProcessOne Contribution License Agreement][cla] in PDF.
[github-new-issue]: https://github.com/processone/ejabberd/issues/new [github-new-issue]: https://github.com/processone/ejabberd/issues/new
[github-pr]: https://github.com/processone/ejabberd/pulls [github-pr]: https://github.com/processone/ejabberd/pulls
[doc-repo]: https://github.com/processone/docs.ejabberd.im [doc-repo]: https://github.com/processone/docs.ejabberd.im
[developer-setup]: https://docs.ejabberd.im/developer/
[cla]: https://www.process-one.net/resources/ejabberd-cla.pdf [cla]: https://www.process-one.net/resources/ejabberd-cla.pdf
[license]: https://github.com/processone/ejabberd/blob/master/COPYING
[influx-cla]: https://influxdb.com/community/cla.html