]> O.S.I.I.S - jp/vke.net.git/commitdiff
contribution guide
authorJean-Philippe Bruyère <jp_bruyere@hotmail.com>
Sat, 20 Nov 2021 22:35:32 +0000 (23:35 +0100)
committerJean-Philippe Bruyère <jp_bruyere@hotmail.com>
Sat, 20 Nov 2021 22:35:32 +0000 (23:35 +0100)
CONTRIBUTING.md [new file with mode: 0644]
README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..11cbc2e
--- /dev/null
@@ -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).
index 0ffcbbcdc3350b4e8dd934b93abe223a1f9e8477..996eb062f7d7ec6f90024c5a43b02127bdd85dc5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,6 +14,9 @@
   <a href="https://www.paypal.me/GrandTetraSoftware">
     <img src="https://img.shields.io/badge/Donate-PayPal-green.svg">
   </a>
+  <a href="https://gitter.im/CSharpRapidOpenWidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
+    <img src="https://badges.gitter.im/CSharpRapidOpenWidgets.svg">
+  </a>
 </p>
 </h1>
 
@@ -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