-
Notifications
You must be signed in to change notification settings - Fork 0
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
0 parents
commit 6a30339
Showing
18 changed files
with
5,340 additions
and
0 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,23 @@ | ||
{ | ||
"projectName": "commitlint-config-conventional-system", | ||
"projectOwner": "blackxored", | ||
"files": [ | ||
"README.md" | ||
], | ||
"imageSize": 100, | ||
"commit": false, | ||
"contributors": [ | ||
{ | ||
"login": "blackxored", | ||
"name": "Adrian Perez", | ||
"avatar_url": "https://avatars3.githubusercontent.com/u/133308?v=4", | ||
"profile": "https://adrianperez.codes", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"infra", | ||
"test" | ||
] | ||
} | ||
] | ||
} |
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,11 @@ | ||
# EditorConfig is awesome: http://EditorConfig.org | ||
|
||
# top-most EditorConfig file | ||
root = true | ||
|
||
# Unix-style newlines with a newline ending every file | ||
[*] | ||
end_of_line = lf | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 2 |
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 @@ | ||
node_modules | ||
coverage | ||
dist | ||
lib | ||
es | ||
wallaby.config.js |
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,20 @@ | ||
module.exports = { | ||
extends: ['airbnb-base', 'prettier'], | ||
parser: 'babel-eslint', | ||
plugins: ['prettier', 'jest'], | ||
env: { | ||
jest: true, | ||
}, | ||
rules: { | ||
'arrow-parens': 0, // does not work with Flow generic types. | ||
'global-require': 0, // used by react-native | ||
'import/first': 0, // we sort by unit/atom | ||
'import/no-named-as-default': 0, // we export components for testing | ||
'import/prefer-default-export': 0, // actions can have only one action | ||
'no-confusing-arrow': 0, // this rule is confusing | ||
'no-duplicate-imports': 0, // handled by eslint-plugin-import | ||
'no-underscore-dangle': 0, | ||
'require-jsdoc': 'warn', | ||
'valid-jsdoc': 'error', | ||
}, | ||
}; |
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,38 @@ | ||
<!-- | ||
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Please fill out this template with all the relevant information so we can | ||
understand what's going on and fix the issue. | ||
I'll probably ask you to submit the fix (after giving some direction). If you've | ||
never done that before, that's great! Check this free short video tutorial to | ||
learn how: http://kcd.im/pull-request | ||
--> | ||
|
||
* `commitlint-config-conventional-system` version: | ||
* `node` version: | ||
* `npm` (or `yarn`) version: | ||
|
||
Relevant code or config | ||
|
||
```javascript | ||
``` | ||
|
||
What you did: | ||
|
||
What happened: | ||
|
||
<!-- Please provide the full error message/screenshots/anything --> | ||
|
||
Reproduction repository: | ||
|
||
<!-- | ||
If possible, please create a repository that reproduces the issue with the | ||
minimal amount of code possible. | ||
--> | ||
|
||
Problem description: | ||
|
||
Suggested solution: |
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,44 @@ | ||
<!-- | ||
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Also, please make sure you're familiar with and follow the instructions in the | ||
contributing guidelines (found in the CONTRIBUTING.md file). | ||
If you're new to contributing to open source projects, you might find this free | ||
video course helpful: http://kcd.im/pull-request | ||
Please fill out the information below to expedite the review and (hopefully) | ||
merge of your pull request! | ||
--> | ||
|
||
<!-- What changes are being made? (What feature/bug is being fixed here?) --> | ||
|
||
**What**: | ||
|
||
<!-- Why are these changes necessary? --> | ||
|
||
**Why**: | ||
|
||
<!-- How were these changes implemented? --> | ||
|
||
**How**: | ||
|
||
<!-- Have you done all of these things? --> | ||
|
||
**Checklist**: | ||
|
||
<!-- add "N/A" to the end of each line that's irrelevant to your changes --> | ||
|
||
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" --> | ||
|
||
* [ ] Documentation | ||
* [ ] Tests | ||
* [ ] Ready to be merged | ||
<!-- In your opinion, is this ready to be merged as soon as it's reviewed? --> | ||
* [ ] Added myself to contributors table | ||
<!-- this is optional, see the contributing guidelines for instructions --> | ||
|
||
<!-- feel free to add additional comments --> |
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,86 @@ | ||
### Node ### | ||
|
||
# Logs | ||
logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Dependency directories | ||
/node_modules | ||
/jspm_packages | ||
/bower_components | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# dotenv environment variables file(s) | ||
.env | ||
.env.* | ||
|
||
#Build generated | ||
dist/ | ||
build/ | ||
es/ | ||
lib/ | ||
|
||
### SublimeText ### | ||
# cache files for sublime text | ||
*.tmlanguage.cache | ||
*.tmPreferences.cache | ||
*.stTheme.cache | ||
|
||
# workspace files are user-specific | ||
*.sublime-workspace | ||
|
||
# project files should be checked into the repository, unless a significant | ||
# proportion of contributors will probably not be using SublimeText | ||
# *.sublime-project | ||
|
||
|
||
### VisualStudioCode ### | ||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
|
||
### WebStorm/IntelliJ ### | ||
/.idea | ||
modules.xml | ||
*.ipr | ||
|
||
|
||
### System Files ### | ||
.DS_Store | ||
|
||
# Windows thumbnail cache files | ||
Thumbs.db | ||
ehthumbs.db | ||
ehthumbs_vista.db | ||
|
||
# Folder config file | ||
Desktop.ini | ||
|
||
# Recycle Bin used on file shares | ||
$RECYCLE.BIN/ | ||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear in the root of a volume | ||
.DocumentRevisions-V100 | ||
.fseventsd | ||
.Spotlight-V100 | ||
.TemporaryItems | ||
.Trashes | ||
.VolumeIcon.icns | ||
|
||
# Yeoman storage | ||
.yo-rc.json |
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,15 @@ | ||
language: node_js | ||
cache: | ||
directories: | ||
- ~/.npm | ||
notifications: | ||
email: false | ||
node_js: | ||
- '9' | ||
- '8' | ||
- '6' | ||
after_success: | ||
- npm run semantic-release | ||
branches: | ||
except: | ||
- /^v\d+\.\d+\.\d+$/ |
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,75 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of | ||
experience, nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
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, or to ban temporarily or permanently any | ||
contributor for other behaviors that they deem inappropriate, threatening, | ||
offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team leader at [`adrian@adrianperez.org`]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an | ||
incident. Further details of specific enforcement policies may be posted | ||
separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 1.4, available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct/ | ||
|
||
[homepage]: https://www.contributor-covenant.org |
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,69 @@ | ||
# Contributing | ||
|
||
Thanks for being willing to contribute! | ||
|
||
**Working on your first Pull Request?** You can learn how from this _free_ | ||
series [How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
||
## Project setup | ||
|
||
1. Fork and clone the repo | ||
2. `$ yarn` to install dependencies | ||
3. `$ yarn test` to validate you've got it working | ||
4. Create a branch for your PR | ||
|
||
> Tip: Keep your `master` branch pointing at the original repository and make | ||
> pull requests from branches on your fork. To do this, run: | ||
> | ||
> ``` | ||
> git remote add upstream https://github.com/blackxored/commitlint-config-conventional-system.git | ||
> git fetch upstream | ||
> git branch --set-upstream-to=upstream/master master | ||
> ``` | ||
> | ||
> This will add the original repository as a "remote" called "upstream," Then | ||
> fetch the git information from that remote, then set your local `master` | ||
> branch to use the upstream master branch whenever you run `git pull`. Then you | ||
> can make all of your pull request branches based on this `master` branch. | ||
> Whenever you want to update your version of `master`, do a regular `git pull`. | ||
## Add yourself as a contributor | ||
|
||
This project follows the [all contributors][all-contributors] specification. To | ||
add yourself to the table of contributors on the README.md, please use the | ||
automated script as part of your PR: | ||
|
||
```console | ||
yarn run contributors:add | ||
``` | ||
|
||
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. If | ||
you've already added yourself to the list and are making a new type of | ||
contribution, you can run it again and select the added contribution type. | ||
|
||
## Committing and Pushing changes | ||
|
||
This project uses [`semantic-release`][semantic-release] to do automatic | ||
releases and generate a changelog based on the commit history. So we follow [a | ||
convention][convention] for commit messages. You don't have to follow this | ||
convention if you don't like to, although we've provided hooks to make it easier | ||
for you to adhere to them if you so choose. Just know that when we merge your | ||
commit, we'll probably use "Squash and Merge" so we can change the commit | ||
message :) | ||
|
||
Please make sure to run the tests before you commit your changes. You can run | ||
`npm test -- -u` which will update any snapshots that need updating. Make sure | ||
to include those changes (if they exist) in your commit. | ||
|
||
## Help needed | ||
|
||
Please checkout the [the open issues][issues] | ||
|
||
Also, please watch the repo and respond to questions/bug reports/feature | ||
requests! Thanks! | ||
|
||
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github | ||
[semantic-release]: https://npmjs.com/package/semantic-release | ||
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md | ||
[all-contributors]: https://github.com/kentcdodds/all-contributors | ||
[issues]: https://github.com/blackxored/commitlint-config-conventional-system/issues |
Oops, something went wrong.