From 68e5e8e7400748d0232069dc1c08d80c8bbc73da Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Sun, 9 Jun 2013 20:34:15 -0300 Subject: [PATCH 1/3] Kick off CONTRIBUTING.md based on @anselmh's https://github.com/anselmh/CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6a19c3f34 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# How to contribute + +I like to encourage you to contribute to the repository. +This should be as easy as possible for you but there are a few things to consider when contributing. +The following guidelines for contribution should be followed if you want to submit a pull request. + +## How to prepare + +* You need a [GitHub account](https://github.com/signup/free) +* Submit an [issue ticket](https://github.com/anselmh/modx-boilerplate-evo/issues) for your issue if the is no one yet. + * Describe the issue and include steps to reproduce when it's a bug. + * Ensure to mention the earliest version that you know is affected. +* Fork the repository on GitHub + +## Make Changes + +* In your forked repository, create a topic branch for your upcoming patch. + * Usually this is based on the master branch. + * Create a branch based on master; `git branch + fix/master/my_contribution master` then checkout the new branch with `git + checkout fix/master/my_contribution`. Please avoid working directly on the `master` branch. +* Make commits of logical units and describe them properly. +* Check for unnecessary whitespace with `git diff --check` before committing. + +* If possible, submit tests to your patch / new feature so it can be tested easily. +* Assure nothing is broken by running all the tests. + +## Submit Changes + +* Push your changes to a topic branch in your fork of the repository. +* Open a pull request to the original repository and choose the right original branch you want to patch. +* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. +* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve. + +# Additional Resources + +* [General GitHub documentation](http://help.github.com/) +* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) From 9b947d0c4a6f573f897e11fc49b17cb07db268b1 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Sun, 9 Jun 2013 20:40:26 -0300 Subject: [PATCH 2/3] Change link to issue tracker on CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a19c3f34..b8d869faf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ # How to contribute -I like to encourage you to contribute to the repository. +We like to encourage you to contribute to the repository. This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request. ## How to prepare * You need a [GitHub account](https://github.com/signup/free) -* Submit an [issue ticket](https://github.com/anselmh/modx-boilerplate-evo/issues) for your issue if the is no one yet. +* Submit an [issue ticket](https://github.com/mitchellh/vagrant/issues) for your issue if the is no one yet. * Describe the issue and include steps to reproduce when it's a bug. * Ensure to mention the earliest version that you know is affected. * Fork the repository on GitHub From 2c806079c9153ea593eee3b5dc5efbbb76df9f49 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Sun, 9 Jun 2013 20:41:26 -0300 Subject: [PATCH 3/3] Add notes about debugging logs to contributing guidelines --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8d869faf..fc5d3c576 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,9 @@ The following guidelines for contribution should be followed if you want to subm * Submit an [issue ticket](https://github.com/mitchellh/vagrant/issues) for your issue if the is no one yet. * Describe the issue and include steps to reproduce when it's a bug. * Ensure to mention the earliest version that you know is affected. + * If you plan on submitting a bug report, please submit debug-level logs along + with the report using [gist](https://gist.github.com/) or some other paste + service by prepending `VAGRANT_LOG=debug` to your `vagrant` commands. * Fork the repository on GitHub ## Make Changes