mirror of
https://github.com/dg/dibi.git
synced 2025-08-03 20:57:36 +02:00
updated contributing.md, added GitHub templates
This commit is contained in:
1
.gitattributes
vendored
1
.gitattributes
vendored
@@ -1,4 +1,5 @@
|
||||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
.github export-ignore
|
||||
.travis.yml export-ignore
|
||||
tests/ export-ignore
|
||||
|
16
.github/issue_template.md
vendored
Normal file
16
.github/issue_template.md
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
- bug report? yes/no
|
||||
- feature request? yes/no
|
||||
- version: ?.?.? <!-- exact release version, for bug reports -->
|
||||
|
||||
### Description
|
||||
...
|
||||
|
||||
### Steps To Reproduce
|
||||
... If possible a minimal demo of the problem ...
|
||||
|
||||
<!--
|
||||
REMEMBER, AN ISSUE IS NOT THE PLACE TO ASK QUESTIONS. We will be happy to help you on Gitter https://gitter.im/nette/nette
|
||||
|
||||
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.
|
||||
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.
|
||||
-->
|
11
.github/pull_request_template.md
vendored
Normal file
11
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
- bug fix? yes/no <!-- #issue numbers, if any -->
|
||||
- new feature? yes/no
|
||||
- BC break? yes/no
|
||||
|
||||
<!--
|
||||
Describe your changes here to communicate to the maintainers why we should accept this pull request.
|
||||
|
||||
Please add new tests to show the fix or feature works.
|
||||
|
||||
Thanks for contributing!
|
||||
-->
|
@@ -1,27 +1,31 @@
|
||||
How to contribute & use the issue tracker
|
||||
=========================================
|
||||
|
||||
The issue tracker is the preferred channel for bug reports, features requests
|
||||
and submitting pull requests, but please respect the following restrictions:
|
||||
Dibi welcomes your contributions. There are several ways to help out:
|
||||
|
||||
* Please **do not** use the issue tracker for personal support requests (use
|
||||
[dibi forum](https://forum.dibiphp.com) or [Stack Overflow](http://stackoverflow.com)).
|
||||
* Create an issue on GitHub, if you have found a bug
|
||||
* Write test cases for open bug issues
|
||||
* Write fixes for open bug/feature issues, preferably with test cases included
|
||||
* Contribute to the documentation
|
||||
|
||||
* Please **do not** derail or troll issues. Keep the discussion on topic and
|
||||
respect the opinions of others.
|
||||
Issues
|
||||
------
|
||||
|
||||
* Use the GitHub **issue search** — check if the issue has already been
|
||||
reported.
|
||||
Please **do not use the issue tracker to ask questions**. We will be happy to help you
|
||||
on [Dibi forum](https://forum.dibiphp.com).
|
||||
|
||||
A good **bug report** shouldn't leave others needing to chase you up for more
|
||||
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.
|
||||
|
||||
**Feature requests** are welcome. But take a moment to find out whether your idea
|
||||
fits with the scope and aims of the project. It's up to *you* to make a strong
|
||||
case to convince the project's developers of the merits of this feature.
|
||||
|
||||
We welcome **pull requests**. If you'd like to contribute, please take a moment
|
||||
to [read the guidelines](https://nette.org/en/contributing) in order to make
|
||||
the contribution process easy and effective for everyone involved.
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Thanks!
|
||||
The best way to propose a feature is to discuss your ideas on [Dibi forum](https://forum.dibiphp.com) before implementing them.
|
||||
|
||||
Please do not fix whitespace, format code, or make a purely cosmetic patch.
|
||||
|
||||
Thanks! :heart:
|
||||
|
Reference in New Issue
Block a user