Skip to content

Commit 7447ad4

Browse files
committed
updated contributing.md, added GitHub templates
1 parent 58a8d22 commit 7447ad4

File tree

3 files changed

+48
-13
lines changed

3 files changed

+48
-13
lines changed

.github/issue_template.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
* [x] bug
2+
* [ ] enhancement
3+
* version: <!-- exact release version. PHP version, OS, web server if relevant -->
4+
5+
### Description
6+
...
7+
8+
### Steps To Reproduce
9+
... If possible a minimal demo of the problem ...
10+
11+
<!--
12+
Remember, an issue is not the place to ask questions. We will be happy to help you on forum https://forum.nette.org or chat with us on Gitter https://gitter.im/nette/nette
13+
14+
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.
15+
16+
Feature requests are welcome. Explain your intentions. It's up to you to make a strong case to convince the project's developers of the merits of this feature.
17+
-->

.github/pull_request_template.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
* [ ] bug fix <!-- #issue numbers, if any -->
2+
* [ ] enhancement
3+
* [ ] BC breaks
4+
* [ ] doc PR nette/docs#... <!-- highly welcome, see https://nette.org/en/writing -->
5+
6+
<!--
7+
Describe your changes here to communicate to the maintainers why we should accept this pull request.
8+
9+
Please add new tests to show the fix or feature works. And take a moment to read the contributing guide https://nette.org/en/contributing
10+
11+
Thanks for contributing to Nette!
12+
-->

contributing.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
11
How to contribute & use the issue tracker
22
=========================================
33

4-
The issue tracker is the preferred channel for bug reports, features requests
5-
and submitting pull requests, but please respect the following restrictions:
4+
Nette welcomes your contributions. There are several ways to help out:
65

7-
* Please **do not** use the issue tracker for personal support requests (use
8-
[Nette forum](https://forum.nette.org) or [Stack Overflow](http://stackoverflow.com)).
6+
* Create an issue on GitHub, if you have found a bug
7+
* Write test cases for open bug issues
8+
* Write fixes for open bug/feature issues, preferably with test cases included
9+
* Contribute to the [documentation](https://nette.org/en/writing)
910

10-
* Please **do not** derail or troll issues. Keep the discussion on topic and
11-
respect the opinions of others.
11+
Issues
12+
------
1213

13-
* Use the GitHub **issue search** &mdash; check if the issue has already been
14-
reported.
14+
Please **do not use the issue tracker to ask questions**. We will be happy to help you
15+
on [Nette forum](https://forum.nette.org) or chat with us on [Gitter](https://gitter.im/nette/nette).
1516

16-
A good **bug report** shouldn't leave others needing to chase you up for more
17+
A good bug report shouldn't leave others needing to chase you up for more
1718
information. Please try to be as detailed as possible in your report.
1819

1920
**Feature requests** are welcome. But take a moment to find out whether your idea
2021
fits with the scope and aims of the project. It's up to *you* to make a strong
2122
case to convince the project's developers of the merits of this feature.
2223

23-
Nette welcomes **pull requests**. If you'd like to contribute, please take a moment
24-
to [read the guidelines](https://nette.org/en/contributing) in order to make
25-
the contribution process easy and effective for everyone involved.
24+
Contributing
25+
------------
2626

27-
Thanks!
27+
If you'd like to contribute, please take a moment to read [the contributing guide](https://nette.org/en/contributing).
28+
29+
The best way to propose a feature is to discuss your ideas on [Nette forum](https://forum.nette.org) before implementing them.
30+
31+
Please do not fix whitespace, format code, or make a purely cosmetic patch.
32+
33+
Thanks! :heart:

0 commit comments

Comments
 (0)