maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge updated contribution guidelines.

Browse Source
This commit is contained in:
James Muehlner 2016-05-17 23:52:04 -07:00
commit 7e3c28a1c2
1 changed files with 15 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
CONTRIBUTING
View File

@ -1,37 +1,39 @@
------------------------------------------------------------ ------------------------------------------------------------
Contributing to Guacamole Contributing to Apache Guacamole
------------------------------------------------------------ ------------------------------------------------------------
Thank you for contributing to the Guacamole project! Thank you for contributing to the Apache Guacamole project!
There are certain procedures that must be followed for all contributions. These There are certain procedures that must be followed for all contributions. These
procedures are necessary to allow us to allocate resources for reviewing and procedures are necessary to allow us to allocate resources for reviewing and
testing your contribution, as well as to ensure we have your legal testing your contribution, as well as communicate effectively with you during
authorization to include your contribution in Guacamole. the review process.
1) Create an issue in our JIRA 1) Create an issue in our JIRA
All changes to Guacamole must have corresponding issues in JIRA so the All changes to Guacamole must have corresponding issues in JIRA so the
change can be properly tracked: change can be properly tracked:
http://glyptodon.org/jira/ https://issues.apache.org/jira/browse/GUACAMOLE/
If you do not already have an account on our JIRA, you will need to create If you do not already have an account on the Apache Software Foundation's
one before creating your new issue. JIRA, you will need to create one before creating your new issue.
2) Make and test your changes locally 2) Make and test your changes locally
The Guacamole source is maintained in git repositories hosted on GitHub: The Guacamole source is maintained in git repositories hosted on GitHub:
https://github.com/glyptodon/guacamole-client https://github.com/apache/incubator-guacamole-client
https://github.com/glyptodon/guacamole-server https://github.com/apache/incubator-guacamole-manual
https://github.com/apache/incubator-guacamole-server
https://github.com/apache/incubator-guacamole-website
To make your changes, fork the applicable repositories and make commits To make your changes, fork the applicable repositories and make commits
to a topic branch in your fork. Commits should be made in logical units to a topic branch in your fork. Commits should be made in logical units
and must reference the JIRA issue number: and must reference the JIRA issue number:
$ git commit -m "GUAC-123: Message describing the specific changes made." $ git commit -m "GUACAMOLE-123: High-level message describing the changes."
Avoid commits which cover multiple, distinct goals that could (and should) Avoid commits which cover multiple, distinct goals that could (and should)
be handled separately. be handled separately.
@ -39,28 +41,12 @@ authorization to include your contribution in Guacamole.
If you do not already have an account on GitHub, you will need to create If you do not already have an account on GitHub, you will need to create
one before making your changes. one before making your changes.
3) Sign our Contributor License Agreement (CLA) 3) Submit your changes via a pull request on GitHub
All contributors to the Guacamole project must have signed CLAs on file
before we can merge their contributions:
http://glyptodon.org/cla.html
This is necessary to ensure we have the legal right to include your code
in our repositories, that we can continue to distribute that code under
the MIT license, and that you have the legal right to give us that code.
If you create a pull request without first signing the CLA, you will be
asked to do so before the pull request is reviewed.
4) Submit your changes via a pull request on GitHub
Once your changes are ready, submit them by creating a pull request for Once your changes are ready, submit them by creating a pull request for
the corresponding topic branch you created when you began working on your the corresponding topic branch you created when you began working on your
changes. changes.
The Guacamole team will then review your changes and, if they pass review The Guacamole team will then review your changes and, if they pass review,
and we have your CLA on file, your changes will be allocated to a sprint your changes will be merged.
for final testing and merge, and your name will be added to the list of
contributors for whichever repositories contain your contributions.