-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6845a36
commit 2d63f3e
Showing
9 changed files
with
146 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. | ||
|
||
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Contribution guide | ||
|
||
1. Make sure you always pull the latest changes from the repo and `rebase` from the | ||
`master` branch whenever it's necessary. | ||
2. Always work on the `dev` branch or dedicated branches (e.g.: for features). | ||
3. Don't modify generated files in `/doc` and in `/dist`. | ||
4. Squash commits in branches to reduce the chain whenever its possible. | ||
5. Always **test** your code using `npm test`. | ||
6. If you add new code, ensure that it's covered by test cases. | ||
7. If you fix an issue, mention `fix #x` (where x is the issue number). | ||
8. Ensure that you use the appropriate code style (that can be checked | ||
with `npm run lint`). | ||
9. Make sure you follow the [ESLint commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint). | ||
|
||
## Project structure | ||
- **`build`**: contains built files for distribution. | ||
- **`src`**: contains source files. | ||
- **`test`**: contains all tests, unit tests are written using Jest and E2E are written with Nightwatch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: 🐛 Bug report | ||
about: Create a report to help us improve | ||
--- | ||
|
||
<!--lint disable heading-style --> | ||
## Expected behaviour | ||
|
||
|
||
## Actual behaviour | ||
|
||
|
||
## How to reproduce | ||
<!-- Steps to reproduce the bug --> | ||
|
||
## Possible solution(s) | ||
<!--How do you think, the issue should be solved ? --> | ||
|
||
## Environment | ||
- Version: | ||
- OS(s): | ||
- Browser(s): | ||
- Node version: 10.7.0 | ||
- NPM version: 6.2.0 | ||
|
||
## Link or repo | ||
<!-- Paste a REPL/CodePen/LogRocket or minimal Github repo link --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
name: 🚀 Feature request | ||
about: Submit a proposal for a feature request | ||
--- | ||
|
||
<!--lint disable heading-style --> | ||
## Proposal | ||
|
||
|
||
## Motivation | ||
|
||
|
||
## Use cases and examples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
name: 💬 Question | ||
about: Need support or a question in mind? | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,24 @@ | ||
## Checklist | ||
|
||
- [ ] The PR follows the [guidelines](../wiki/CONTRIBUTING.md) | ||
- [ ] Passes all the tests | ||
- [ ] Contains a valid documentation | ||
- [ ] It's not a duplicate from another PR | ||
- [ ] The PR follows the [guidelines](CONTRIBUTING.md) | ||
- [ ] Passes all the tests (including added/updated ones) | ||
- [ ] Contains a valid documentation | ||
- [ ] It's not a duplicate from another PR | ||
|
||
## Changes | ||
This PR implements: | ||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Documentation/wiki/tutorial update | ||
- [ ] Code style update | ||
- [ ] Build related change | ||
- [ ] CI related change | ||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Refactoring | ||
- [ ] Documentation/wiki/tutorial update | ||
- [ ] Code style update | ||
- [ ] Build related change | ||
- [ ] Other, please specify: | ||
|
||
## Details | ||
What does this PR implements exactly? | ||
What modules/directories are affected by the changes? | ||
Were issues accoutered and remained unsolved? | ||
Who got the idea of that PR? | ||
Who did what on that PR? | ||
If it solves an issue what issue is it? | ||
If it completes one or more tasks (listed in [TODO](../wiki/TODO.md)), which ones are they? | ||
|
||
What issues does this resolve? | ||
<!-- Fixes #1, Closes #2 --> | ||
|
||
If it completes one ore more tasks (listed in [TODO](TODO.md)), which ones are those? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
1. Change dependabot badge to the correct one (in README) | ||
2. Add (S)CSS linting stuff | ||
3. Add git labels | ||
4. Make sure the badges are correct |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
## Configuration for request-info - https://github.com/behaviorbot/request-info | ||
|
||
# *Required* Comment to reply with | ||
#requestInfoReplyComment: > | ||
# We would appreciate it if you could provide us with more info about this issue/PR! | ||
|
||
# *OPTIONAL* default titles to check against for lack of descriptiveness | ||
# MUST BE ALL LOWERCASE | ||
requestInfoDefaultTitles: | ||
- update readme.md | ||
- updates | ||
- error | ||
- issue | ||
|
||
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given | ||
requestInfoLabelToAdd: needs-more-info | ||
|
||
## Configuration for todo - https://github.com/jasonetco/todo | ||
todo: | ||
keyword: "@makeAnIssue" | ||
|
||
# Configuration for welcome - https://github.com/behaviorbot/welcome | ||
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome | ||
|
||
# Comment to be posted to on first time issues | ||
newIssueWelcomeComment: > | ||
Thanks for opening your first issue here! Be sure to follow the issue templates :simple_smile: ! | ||
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome | ||
|
||
# Comment to be posted to on PRs from first time contributors in your repository | ||
newPRWelcomeComment: > | ||
Thanks for opening this PR (Pull Request)! Please check out our [contributing guidelines](https://github.com/Berkmann18/community-starter-kit/blob/master/CONTRIBUTING.md). | ||
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge | ||
|
||
# Comment to be posted to on pull requests merged by a first time user | ||
firstPRMergeComment: > | ||
:tada: Congrats on merging your first PR! We are proud of you! | ||
requestInfoReplyComment: > | ||
We would appreciate it if you could provide us with more info about this issue/PR! | ||
#requestInfoLabelToAdd: request-info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Change this to set the number of comments the watcher should comment on a given PR. | ||
commentLimit: 20 | ||
# The message the bot will post on any lines containing a eslint disable comment. | ||
commentMessage: Please don't disable eslint rules :pray: | ||
# A optional regular expression that will match against the branch name and not comment on it if it matches. | ||
skipBranchMatching: null |