Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

43 lines (23 loc) · 2.72 KB
Raw

Contributing to HGV

Contributions to the HGV project are more than welcome.

License

By contributing code to the HGV project, you agree to license your contribution under the GPL V2 license. Further, with respect to any copyrights in your contribution: 1. you hereby assign to us joint ownership, and to the extent such assignment is invalid, ineffective or unenforceable, you hereby grant to us a perpetual, fully-subliceasable, irrevocable, non-exclusive, worldwide, no-charge, royalty-free, unrestricted license to exercise all rights under those copyrights; 2. we that each of us can act as if we are the sole owner of such copyright, and if one of us makes a derivative work of your contribution, the one who makes the derivative work will be the sole owner; and, 3. we agree that each party may register a copyright in your contribution and exercise all ownership rights associated with it. The rights that you grant us are effective on the date you first submit a contribution.

Issues

Open a GitHub issue for anything. Don't worry if you find yourself opening something that sounds like it could be obvious. Someone else might have the same question.

Comments

Comment on any GitHub issue, open or closed. The only guidelines here are to be friendly and welcoming. If you see that a question has been asked and you think you know the answer, feel free to respond. No need to wait!

Pull Requests

Submit a pull request at any time, whether an issue has been created or not. It may be helpful to discuss your goals in an issue first, though many things can best be shown with code.

We do ask that the pull request be submitted against the current master branch. Every effort is made to make the pull request as stable as possible before merging it in, so we aren't too worried. A list of stable releases is maintained as we go and can be used by anyone concerned by ongoing development.

Code Style

Ansible

The vast majority of HGV is written in and powered by Ansible. We are developing an Ansible scripting standard.

Bash Scripting

For any shell scripting that we do in Bash — see bin/hgv-init.sh — we try to follow the style provided in Google's Shell Style Guide.

PHP

For any PHP, we try to follow the WordPress core code standards.

Releases

  1. Create the change log history. Checkout the 'master' branch and run the following command:

    git log --no-merges --format=" * %ad %an: %s" v1.0..HEAD --date=short

  2. Prepend the output in the CHANGELOG.md file.

  3. Draft an new release.