Skip to content

Commit 6b2482a

Browse files
author
Francesco Schwarz
authored
Update CONTRIBUTING.md
1 parent 19fcf4b commit 6b2482a

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
1-
# ProcessWire Issue Reports
2-
3-
Thank you for helping to identify issues in ProcessWire. We manage issues from this separate
4-
repository so that we can maintain a collaborative team to assist with issue reports.
5-
6-
- Submit ProcessWire issue reports to the issues repository:
7-
[processwire-issues](https://github.com/processwire/processwire-issues/issues)
8-
9-
- Please do not submit feature requests to the issues repository, instead use the requests repository:
10-
[processwire-requests](https://github.com/processwire/processwire-requests/issues)
11-
12-
- Please do not use the issues repository for ProcessWire support, instead use the support forum:
13-
<https://processwire.com/talk/>
14-
15-
- Always include the full ProcessWire version (i.e. 3.0.34). Also include the PHP or MySQL version
16-
when potentially applicable.
17-
18-
- Indicate any 3rd party modules that are installed.
19-
20-
- When possible please confirm the issue on a separate installation before submitting
21-
an issue report.
22-
23-
- When the issue is resolved, please close it.
1+
# Contributing to the ProcessWire issues repository
242

3+
Thank you for taking the time to identify issues in ProcessWire. :+1:
4+
5+
We manage issues from this separate repository so that we can maintain a collaborative team to assist with issue reports.
6+
7+
The following is a set of guidelines for contributing to this repository. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a [pull request](https://github.com/processwire/processwire-issues/pulls).
8+
9+
## Code of conduct
10+
11+
This project adheres to the Contributor Covenant [code of conduct](https://github.com/processwire/processwire-issues/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
12+
13+
## Before submitting a bug report
14+
15+
There is a good chance that you don’t need to create a bug report in the first place. Please check the following list:
16+
17+
* When possible please **confirm the issue on a separate installation** before submitting an issue report.
18+
* Please **do not submit feature requests**, instead use the [requests repository](https://github.com/processwire/processwire-requests/issues).
19+
* Please **do not use this repository for ProcessWire support**, instead use the [support forum](https://processwire.com/talk/).
20+
* **Check the [FAQs on the forum](https://processwire.com/talk/forum/6-faqs/)** for a list of common questions and problems.
21+
* **Perform a [cursory search](https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aprocesswire)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
22+
23+
## How to submit a (good) bug report
24+
25+
Always include as many details as possible. There is an [issue template](https://github.com/processwire/processwire-issues/blob/master/.github/ISSUE_TEMPLATE.md) which gets used automatically when you create a new issue. Please use it as it contains all the information needed for a good bug report.
26+
27+
This will help maintainers and the community understand your report, reproduce the behavior, find related reports, and get to a solution more quickly and efficiently.

0 commit comments

Comments
 (0)