From 7ef8f0586253709ae6ad5939bd0feb13b0d8bf05 Mon Sep 17 00:00:00 2001 From: Peter Heywood Date: Sun, 27 Sep 2015 17:10:10 +0100 Subject: [PATCH 1/2] Add initial version of contributing document --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..36cb9a7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# How to contribute + +The following guidelines should be followed if you wish to contribute to the OpenAB website. + + +## Use the Issue Tracker +If you find a bug or want to request a feature please create an issue on our [Issue Tracker](https://github.com/OpenAB/openab.github.io/issues). + + +## Pull Requests +Other than members of the OpenAB organisation with direct access to this repository, contributions should be made via [Pull Request](https://github.com/OpenAB/openab.github.io/pulls) as follows: + ++ **Fork the repository** and clone it locally. ++ **Create a feature branch** for your changes. ++ **Make your changes** following the style as the rest of the repository. ++ **Test your changes.** Make sure your changes have not broken anything. ++ **Open a Pull Request** where your changes can be discussed and then accepted. + + +## Code Style +Please follow the same code style as found in existing files of the same type. + + +## Further Information ++ [GitHub Issues Guide](https://guides.github.com/features/issues/) ++ [GitHub Forking Guide](http://guides.github.com/activities/forking/) ++ [GitHub Branching Guide](http://guides.github.com/introduction/flow/) ++ [GitHub Pull Request Guide](https://help.github.com/articles/using-pull-requests/) \ No newline at end of file From ae2dd4ecb50f01db65d49e15d52ac3913cb1ece8 Mon Sep 17 00:00:00 2001 From: Peter Heywood Date: Sun, 27 Sep 2015 17:12:51 +0100 Subject: [PATCH 2/2] Add link to CONTRIBUTING.md to readme.md --- readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readme.md b/readme.md index 42b172e..180ce35 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,8 @@ # openab.github.io Jekyll powered website for the Open Agent Benchmark project. + + +## Contributing + +Please consult the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to contribute to the OpenAB website. \ No newline at end of file