Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Contributing document #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/)
5 changes: 5 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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.