From 5491ad8d813731274e337a7125d98735e1722028 Mon Sep 17 00:00:00 2001 From: Jean Hertel Date: Thu, 24 Jan 2019 18:34:52 -0200 Subject: [PATCH] Add a AUTHORS and CONTRIBUTING file --- AUTHORS | 12 ++++++++++++ CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ README.md | 6 ++++++ 3 files changed, 54 insertions(+) create mode 100644 AUTHORS create mode 100644 CONTRIBUTING.md diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..c2775d0 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,12 @@ +Adriconf is written and maintained by Jean Hertel. + +Other authors and contributors include, but are not limited to: + +Balló György +Christoph Haag +Gert Wollny +Harald H. +Hugo Locurcio +Nicolai Hähnle +Rob Clark +Veluri Mithun diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a5559a4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to adriconf + +Our project is always open to new contributions. +Be it a code change, a bug report on even an idea, get in touch with us and we can try to help. + +## Reporting issues + +Reporting issues is a good way to contribute to the project. We always appreciate a well-written, +thorough bug reports. + +Prior to raising a new issue, check out our issue list to determine whether it already include the +problem you are facing. + +A good bug report shouldn't leave others needing to chase you up for more information. Please try to +be as detailed as possible. +The following questions might help us better understand the issue: + +- What were you trying to achieve? +- What brand and models of GPUs you have? +- How many monitors you have? +- Are you running X11? Maybe Wayland? +- Are you using the latest mesa version? +- Is your distribution and adriconf updated? +- What are the expected results? +- What are the received results? +- What are the steps to reproduce the issue? + +## Pull requests + +If you prefer to make the changes you want/need and send them directly to us, we kindly +ask you to try following the same code style. +There is no official coding style or code standard, so this should not be a blocker, +but please try to at least follow the same way the code is written. + +Your Pull Request will only be accepted if the units tests are passing, so test +your changes before submitting it. diff --git a/README.md b/README.md index 001291c..2bfc414 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,12 @@ you will need to add it to the [mesa](https://www.mesa3d.org/) project itself. ## Author This tool is written and maintained by Jean Lorenz Hertel. +To see a full list of contributos check the AUTHORS file included in the source +code. + +## Contributing + +Check our CONTRIBUTING file for further details on how to contribute. ## License