You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Contributions are **welcome** and will be fully **credited**.
4
+
5
+
Please read and understand the contribution guide before creating an issue or pull request.
6
+
7
+
## Etiquette
8
+
9
+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10
+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11
+
extremely unfair for them to suffer abuse or anger for their hard work.
12
+
13
+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14
+
world that developers are civilized and selfless people.
15
+
16
+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17
+
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18
+
19
+
## Viability
20
+
21
+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22
+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23
+
whether or not your feature is likely to be used by other users of the project.
24
+
25
+
## Procedure
26
+
27
+
Before filing an issue:
28
+
29
+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30
+
- Check to make sure your feature suggestion isn't already present within the project.
31
+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32
+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33
+
34
+
Before submitting a pull request:
35
+
36
+
- Check the codebase to ensure that your feature doesn't already exist.
37
+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38
+
39
+
## Requirements
40
+
41
+
If the project maintainer has any additional requirements, you will find them listed here.
42
+
43
+
-**[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
44
+
45
+
-**Add tests!** - Your patch won't be accepted if it doesn't have tests.
46
+
47
+
-**Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48
+
49
+
-**Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50
+
51
+
-**One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52
+
53
+
-**Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
# Configuration for todo - https://github.com/JasonEtco/todo
2
+
todo:
3
+
keyword: "@todo"
4
+
5
+
6
+
7
+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
8
+
# Comment to be posted to on first time issues
9
+
newIssueWelcomeComment: >
10
+
Thanks for opening your first issue here! Be sure to follow the issue template!
11
+
12
+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
13
+
# Comment to be posted to on PRs from first time contributors in your repository
14
+
newPRWelcomeComment: >
15
+
Thanks for opening this pull request! Please check out our contributing guidelines.
16
+
17
+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
18
+
# Comment to be posted to on pull requests merged by a first time user
19
+
firstPRMergeComment: >
20
+
Congrats on merging your first pull request! We here at behaviorbot are proud of you!
21
+
# It is recommend to include as many gifs and emojis as possible
22
+
23
+
24
+
25
+
# Configuration for request-info - https://github.com/behaviorbot/request-info
26
+
# *OPTIONAL* Comment to reply with
27
+
# Can be either a string :
28
+
requestInfoReplyComment: >
29
+
We would appreciate it if you could provide us with more info about this issue/pr!
30
+
31
+
# Or an array:
32
+
# requestInfoReplyComment:
33
+
# - Ah no! young blade! That was a trifle short!
34
+
# - Tell me more !
35
+
# - I am sure you can be more effusive
36
+
37
+
38
+
# *OPTIONAL* default titles to check against for lack of descriptiveness
39
+
# MUST BE ALL LOWERCASE
40
+
requestInfoDefaultTitles:
41
+
- update readme.md
42
+
- updates
43
+
44
+
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
45
+
requestInfoLabelToAdd: needs-more-info
46
+
47
+
# *OPTIONAL* Require Issues to contain more information than what is provided in the issue templates
48
+
# Will fail if the issue's body is equal to a provided template
49
+
checkIssueTemplate: true
50
+
51
+
# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template
52
+
# Will fail if the pull request's body is equal to the provided template
53
+
checkPullRequestTemplate: true
54
+
55
+
# *OPTIONAL* Only warn about insufficient information on these events type
56
+
# Keys must be lowercase. Valid values are 'issue' and 'pullRequest'
57
+
requestInfoOn:
58
+
pullRequest: true
59
+
issue: true
60
+
61
+
# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on
62
+
# keys must be GitHub usernames
63
+
requestInfoUserstoExclude:
64
+
- guannguans
65
+
66
+
67
+
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
68
+
# Comment to be posted to on PRs that don't update documentation
69
+
updateDocsComment: >
70
+
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.
0 commit comments