From d20a90585eb208ea83dfa9265428e450d2b717e0 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Philippe=20Bruy=C3=A8re?= Date: Sun, 21 Nov 2021 00:57:30 +0100 Subject: [PATCH] contributing --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 8 ++++++++ 2 files changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..11cbc2e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing + +* [Getting Started](#getting-started) + * [Issues](#issues) + * [Pull Requests](#pull-requests) +* [Getting Help](#getting-help) + +## Getting Started + +Contributions are made to this repo via Issues and Pull Requests on github (PRs). + +### Issues + +Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. + +If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter. + +### Pull Requests + +PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. + +In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr) + +1. Fork the repository to your own Github account +2. Clone the project to your machine +3. Create a branch locally with a succinct but descriptive name +4. Commit changes to the branch +5. Following any formatting and testing guidelines specific to this repo +6. Push changes to your fork +7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes. + +## Getting Help + +Join us on [gitter](https://gitter.im/CSharpRapidOpenWidgets). diff --git a/README.md b/README.md index 7ab3888..cad6814 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ + + +

@@ -81,6 +84,11 @@ A [detailed tutorial](doc/windows_build_tutorial.md) is available for Windows. Append the `-h` option to see available command line parameters. +### Contributing + +See the [contribution guide](https://github.com/glfw/glfw/blob/master/docs/CONTRIBUTING.md) for more information. + +Join us on [gitter](https://gitter.im/CSharpRapidOpenWidgets) for any question. ### To Do -- 2.47.3