CONTRIBUTING (1984B)
1 2------------------------------------------------------------ 3 Contributing to Apache Guacamole 4------------------------------------------------------------ 5 6Thank you for contributing to the Apache Guacamole project! 7 8There are certain procedures that must be followed for all contributions. These 9procedures are necessary to allow us to allocate resources for reviewing and 10testing your contribution, as well as communicate effectively with you during 11the review process. 12 131) Create an issue in our JIRA 14 15 All changes to Guacamole must have corresponding issues in JIRA so the 16 change can be properly tracked: 17 18 https://issues.apache.org/jira/browse/GUACAMOLE/ 19 20 If you do not already have an account on the Apache Software Foundation's 21 JIRA, you will need to create one before creating your new issue. 22 232) Make and test your changes locally 24 25 The Guacamole source is maintained in git repositories hosted on GitHub: 26 27 https://github.com/apache/guacamole-client 28 https://github.com/apache/guacamole-manual 29 https://github.com/apache/guacamole-server 30 https://github.com/apache/guacamole-website 31 32 To make your changes, fork the applicable repositories and make commits 33 to a topic branch in your fork. Commits should be made in logical units 34 and must reference the JIRA issue number: 35 36 $ git commit -m "GUACAMOLE-123: High-level message describing the changes." 37 38 Avoid commits which cover multiple, distinct goals that could (and should) 39 be handled separately. 40 41 If you do not already have an account on GitHub, you will need to create 42 one before making your changes. 43 443) Submit your changes via a pull request on GitHub 45 46 Once your changes are ready, submit them by creating a pull request for 47 the corresponding topic branch you created when you began working on your 48 changes. 49 50 The Guacamole team will then review your changes and, if they pass review, 51 your changes will be merged. 52