From 9874882774ff40081c0a0ddfb743abdad6e63d17 Mon Sep 17 00:00:00 2001 From: icex2 Date: Fri, 27 Sep 2019 23:36:52 +0200 Subject: [PATCH] README: Move contributing section from README.md to dedicated file --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ README.md | 28 +++------------------------- 2 files changed, 30 insertions(+), 25 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fec9bd6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing +Please have a look at the issue board about what's currently going on. If you see an issue that is not assigned yet and +that you can and want to work on, please leave a comment to reach out to one of our developers. You can also ask +questions and discuss the issue. + +# Bug reports +Please check if the bug was already reported by searching the existing issues. If it does, feel free to leave a comment +that you also have this issue. Add additional information, screenshots, log files etc. The more information and details +we have, the easier it might get to solve the issue. + +When creating new issues, use our template for reporting bugs. It tells you what kind of information we need. + +# Pull requests: bugfixes, new features or other code contributions +Pull requests are welcome! May it be a PR to an already known issue or a new feature that you consider as a valuable +contribution, please open a PR. If you want to start working on a new feature that was proposed in an issue, yet, it +is recommended to reach out to the developers about this, first, to discuss if this contribution is valuable to the +project. Otherwise, you might waste your time on implementing something that won't make it into master. + +Please read our [development guidelines](doc/development.md) as they contain valuable information that your contribution +meets our standards. + +Once submitted, we will review your contribution and get back to you about any changes or when we merge them to our +upstream repository. Your changes, once approved, will be included in the next release. + +# Roadmap +No concrete roadmap or timeline exists. We want to continue adding support for new games as well as old games (some of +the old games supported by BT4 are not supported, yet). \ No newline at end of file diff --git a/README.md b/README.md index 5d3c71f..cabb3dc 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,9 @@ You will find *.md files in various sub-packages that give you further instructi or FAQ. We advice you to read them as your questions and concerns might already be answered by them. If not, let us know if there is any information that you consider helpful or important to know and should be added. +# Contributions +Please refer to the [dedicated documentation](CONTRIBUTING.md). + # Development ## API Please refer to the [API documentation](doc/api.md). @@ -71,31 +74,6 @@ Please refer to the [API documentation](doc/api.md). The source code is included with this distribution package (src.zip). Please refer to the [development document](doc/development.md) for further details. -## Bugs and TODOs -We have our own issue tracker for this. If you want to contribute or have any bugs to report, please reach out to us on -the various channels we are available on. Please help us by providing a detailed description of your concern including: -* The version of bemanitools you are using -* The games affected including version -* Log output of bemanitools and the game -* The APIs you have been using with bemanitools, e.g. iidxio-keyboard, eamio-keyboard. -* The OS version you are running this on -* Specs of your hardware including CPU, RAM, GPU -* A detailed description of your issue. Describe the symptoms and the steps to trigger and reproduce them. Videos and -screenshots might be helpful depending on the issue. - -## Contributions -Patches are welcome! Let us know if you have any contributions, e.g. bugfixes, and send us a patch file. Please read -our [development guidelines](doc/development.md) as they contain valuable information that your contribution meets our -standards. - -Once submitted, we will review your contribution and get back to you about any changes or when we merge them to our -upstream repository. Your changes, once approved, will be included in the next release. - -## Roadmap -No concrete roadmap or timeline exists. We want to continue adding support for new games as well as old games (some of -the old games supported by BT4 are not supported, yet). However, our time and workforce is limited. If you are -interested in contributing, please check the [contribution section](#contributions). - # License Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the [LICENSE file](LICENSE) included with the source code.