Skip to content
Permalink
Browse files
GUAC-1011: Add CONTRIBUTING file describing how to contribute to the …
…Guacamole project. Update README.
  • Loading branch information
mike-jumper committed Jan 21, 2015
1 parent e96020e commit 54d21f9cd8755fc4adc60bd753d3474af416ed0f
Showing 2 changed files with 80 additions and 11 deletions.
@@ -0,0 +1,66 @@

------------------------------------------------------------
Contributing to Guacamole
------------------------------------------------------------

Thank you for contributing to the Guacamole project!

There are certain procedures that must be followed for all contributions. These
procedures are necessary to allow us to allocate resources for reviewing and
testing your contribution, as well as to ensure we have your legal
authorization to include your contribution in Guacamole.

1) Create an issue in our JIRA

All changes to Guacamole must have corresponding issues in JIRA so the
change can be properly tracked:

http://glyptodon.org/jira/

If you do not already have an account on our JIRA, you will need to create
one before creating your new issue.

2) Make and test your changes locally

The Guacamole source is maintained in git repositories hosted on GitHub:

https://github.com/glyptodon/guacamole-client
https://github.com/glyptodon/guacamole-server

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
and must reference the JIRA issue number:

$ git commit -m "GUAC-123: Message describing the specific changes made."

Avoid commits which cover multiple, distinct goals that could (and should)
be handled separately.

If you do not already have an account on GitHub, you will need to create
one before making your changes.

3) Sign our Contributor License Agreement (CLA)

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
the corresponding topic branch you created when you began working on your
changes.

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
for final testing and merge, and your name will be added to the list of
contributors for whichever repositories contain your contributions.

25 README
@@ -6,12 +6,11 @@
This README is intended to provide quick and to-the-point documentation for
technical users intending to compile parts of Guacamole themselves.

Distribution-specific packages are available from the files section of the main
project page:
Source archives are available from the files section of the main project page:

http://sourceforge.net/projects/guacamole/files/

Distribution-specific documentation is provided on the Guacamole wiki:
A full manual is provided on the Guacamole web site:

http://guac-dev.org/

@@ -36,11 +35,6 @@ proxy which translates between arbitrary protocols and the Guacamole protocol.
Compiling and installing guacd, libguac, etc.
------------------------------------------------------------

Please note that distribution-specific pre-compiled packages are available from
the files section of the main project site:

http://sourceforge.net/projects/guacamole/files/

All software within guacamole-server is built using the popular GNU Automake,
and thus provides the standard configure script. Before compiling, you need to
have compiled and installed libguac, the core Guacamole library. This is
@@ -95,7 +89,7 @@ guacd itself directly without the init script (as any user):

$ guacd

guacd currently takes four command-line options:
guacd currently takes several command-line options:

-b HOST

@@ -111,17 +105,26 @@ guacd currently takes four command-line options:
file. This is useful for init scripts and is used by the provided init
script.

-L LEVEL

Sets the maximum level at which guacd will log messages to syslog and,
if running in the foreground, the console. Legal values are debug,
info, warning, and error. The default value is info.

-f
Causes guacd to run in the foreground, rather than automatically
forking into the background.

Additional information can be found in the guacd man page:

$ man guacd

------------------------------------------------------------
Reporting problems
------------------------------------------------------------

Please report any bugs encountered by opening a new ticket at the Trac system
Please report any bugs encountered by opening a new issue in the JIRA system
hosted at:

http://guac-dev.rg/trac/
http://glyptodon.org/jira/

0 comments on commit 54d21f9

Please sign in to comment.