Skip to content

Commit 3fae71f

Browse files
committed
Update contributing and issue template
1 parent 804c3d3 commit 3fae71f

2 files changed

Lines changed: 21 additions & 7 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ OxyPlot is driven by the community and contributors like you. We are excited tha
66
The flow when contributing to OxyPlot is as follows:
77

88
1. Add issue (bug or new feature)
9-
2. Wait for issue to be tagged `you-take-it`
10-
3. Commit your changes and rebase
9+
2. If the issue needs to be clarified, wait for some feedback
10+
3. Commit your changes
11+
4. Update the change log and contributors files
1112
4. Create a pull request
1213

1314
Note that your contributions must be your own work and licensed under the same terms as OxyPlot.
@@ -25,20 +26,29 @@ You could also use services like https://snipt.org or https://gist.github.com to
2526

2627
A bug report should include:
2728

28-
- used platform and tools version
29-
- used OxyPlot version
30-
- version of dependencies (e.g. Xamarin.Forms and Android SDK)
29+
- the platform you are building for (Windows Forms, WPF, Xamarin Forms etc.)
30+
- the framework version (netcore3, net47 etc.)
31+
- the version of OxyPlot you are using
3132
- description of the issue
3233
- sample code to reproduce the issue
34+
- what you expect and what is the actual behaviour
3335

3436

3537
## Suggesting new features
3638

3739
First, search the issue tracker to see if the feature is already there.
3840

39-
Wait for some feedback before starting to work on something that might not be merged in the end.
41+
A feature request should include:
4042

41-
## Create your own fork
43+
- description of the feature
44+
- a drawing/image, if possible
45+
46+
It could be a good idea to wait for some feedback before starting to work on a new feature.
47+
Not all features are general enough to fit into this library.
48+
We don't want you to waste time on something that might not be merged in the end.
49+
50+
51+
## Creating your own fork
4252

4353
1. Log in to GitHub and open the [oxyplot](https://github.com/oxyplot/oxyplot/) origin repository. Click the "Fork" button to create your own fork of the repository.
4454
2. Create a clone on your local system: `git clone https://github.com/yourusername/oxyplot.git`

.github/ISSUE_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Please see https://github.com/oxyplot/oxyplot/wiki/Contributing before creating issues.
33
For issues related to Xamarin, please use https://github.com/oxyplot/oxyplot-xamarin/issues
44
For issues related to other platforms, please add to the correct repository.
5+
6+
PLEASE DO NOT USE THE ISSUES TO ADD QUESTIONS ABOUT HOW TO USE THE LIBRARY.
7+
YOU SHOULD FORMULATE THE ISSUE AS A "BUG REPORT" OR "NEW FEATURE REQUEST",
8+
PLEASE USE ONE OF THE SECTIONS BELOW:
59
-->
610

711
<!-- IF THE ISSUE IS A BUG, INCLUDE THIS PART: -->

0 commit comments

Comments
 (0)