From: Jean-Philippe Bruyère Date: Sat, 20 Nov 2021 22:35:32 +0000 (+0100) Subject: contribution guide X-Git-Tag: v0.2.4-beta~21 X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=506e6f45eb0f08b096e78eba6ae31c8d647df06f;p=jp%2Fvke.net.git contribution guide --- 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 0ffcbbc..996eb06 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,9 @@ + + +

@@ -51,6 +54,13 @@ vke is in beta development stage. | [Triangle](samples/Triangle/README.md) | ![screenshot](samples/screenShots/Triangle.png) | | [Textured](samples/Textured/README.md) | ![screenshot](samples/screenShots/Textured.png) | +# 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. # Features