Skip to content

Commit 6a30339

Browse files
blackxoredblackxored
committed
feat: initial release
0 parents  commit 6a30339

18 files changed

+5340
-0
lines changed

‎.all-contributorsrc

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"projectName": "commitlint-config-conventional-system",
3+
"projectOwner": "blackxored",
4+
"files": [
5+
"README.md"
6+
],
7+
"imageSize": 100,
8+
"commit": false,
9+
"contributors": [
10+
{
11+
"login": "blackxored",
12+
"name": "Adrian Perez",
13+
"avatar_url": "https://avatars3.githubusercontent.com/u/133308?v=4",
14+
"profile": "https://adrianperez.codes",
15+
"contributions": [
16+
"code",
17+
"doc",
18+
"infra",
19+
"test"
20+
]
21+
}
22+
]
23+
}

‎.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
end_of_line = lf
9+
insert_final_newline = true
10+
indent_style = space
11+
indent_size = 2

‎.eslintignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
coverage
3+
dist
4+
lib
5+
es
6+
wallaby.config.js

‎.eslintrc.js

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
module.exports = {
2+
extends: ['airbnb-base', 'prettier'],
3+
parser: 'babel-eslint',
4+
plugins: ['prettier', 'jest'],
5+
env: {
6+
jest: true,
7+
},
8+
rules: {
9+
'arrow-parens': 0, // does not work with Flow generic types.
10+
'global-require': 0, // used by react-native
11+
'import/first': 0, // we sort by unit/atom
12+
'import/no-named-as-default': 0, // we export components for testing
13+
'import/prefer-default-export': 0, // actions can have only one action
14+
'no-confusing-arrow': 0, // this rule is confusing
15+
'no-duplicate-imports': 0, // handled by eslint-plugin-import
16+
'no-underscore-dangle': 0,
17+
'require-jsdoc': 'warn',
18+
'valid-jsdoc': 'error',
19+
},
20+
};

‎.github/ISSUE_TEMPLATE.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--
2+
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
3+
Please make sure that you are familiar with and follow the Code of Conduct for
4+
this project (found in the CODE_OF_CONDUCT.md file).
5+
6+
Please fill out this template with all the relevant information so we can
7+
understand what's going on and fix the issue.
8+
9+
I'll probably ask you to submit the fix (after giving some direction). If you've
10+
never done that before, that's great! Check this free short video tutorial to
11+
learn how: http://kcd.im/pull-request
12+
-->
13+
14+
* `commitlint-config-conventional-system` version:
15+
* `node` version:
16+
* `npm` (or `yarn`) version:
17+
18+
Relevant code or config
19+
20+
```javascript
21+
```
22+
23+
What you did:
24+
25+
What happened:
26+
27+
<!-- Please provide the full error message/screenshots/anything -->
28+
29+
Reproduction repository:
30+
31+
<!--
32+
If possible, please create a repository that reproduces the issue with the
33+
minimal amount of code possible.
34+
-->
35+
36+
Problem description:
37+
38+
Suggested solution:

‎.github/PULL_REQUEST_TEMPLATE.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!--
2+
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
3+
4+
Please make sure that you are familiar with and follow the Code of Conduct for
5+
this project (found in the CODE_OF_CONDUCT.md file).
6+
7+
Also, please make sure you're familiar with and follow the instructions in the
8+
contributing guidelines (found in the CONTRIBUTING.md file).
9+
10+
If you're new to contributing to open source projects, you might find this free
11+
video course helpful: http://kcd.im/pull-request
12+
13+
Please fill out the information below to expedite the review and (hopefully)
14+
merge of your pull request!
15+
-->
16+
17+
<!-- What changes are being made? (What feature/bug is being fixed here?) -->
18+
19+
**What**:
20+
21+
<!-- Why are these changes necessary? -->
22+
23+
**Why**:
24+
25+
<!-- How were these changes implemented? -->
26+
27+
**How**:
28+
29+
<!-- Have you done all of these things? -->
30+
31+
**Checklist**:
32+
33+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
34+
35+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
36+
37+
* [ ] Documentation
38+
* [ ] Tests
39+
* [ ] Ready to be merged
40+
<!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
41+
* [ ] Added myself to contributors table
42+
<!-- this is optional, see the contributing guidelines for instructions -->
43+
44+
<!-- feel free to add additional comments -->

‎.gitignore

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
### Node ###
2+
3+
# Logs
4+
logs
5+
npm-debug.log*
6+
yarn-debug.log*
7+
yarn-error.log*
8+
9+
# Optional npm cache directory
10+
.npm
11+
12+
# Dependency directories
13+
/node_modules
14+
/jspm_packages
15+
/bower_components
16+
17+
# Yarn Integrity file
18+
.yarn-integrity
19+
20+
# Optional eslint cache
21+
.eslintcache
22+
23+
# dotenv environment variables file(s)
24+
.env
25+
.env.*
26+
27+
#Build generated
28+
dist/
29+
build/
30+
es/
31+
lib/
32+
33+
### SublimeText ###
34+
# cache files for sublime text
35+
*.tmlanguage.cache
36+
*.tmPreferences.cache
37+
*.stTheme.cache
38+
39+
# workspace files are user-specific
40+
*.sublime-workspace
41+
42+
# project files should be checked into the repository, unless a significant
43+
# proportion of contributors will probably not be using SublimeText
44+
# *.sublime-project
45+
46+
47+
### VisualStudioCode ###
48+
.vscode/*
49+
!.vscode/settings.json
50+
!.vscode/tasks.json
51+
!.vscode/launch.json
52+
!.vscode/extensions.json
53+
54+
### WebStorm/IntelliJ ###
55+
/.idea
56+
modules.xml
57+
*.ipr
58+
59+
60+
### System Files ###
61+
.DS_Store
62+
63+
# Windows thumbnail cache files
64+
Thumbs.db
65+
ehthumbs.db
66+
ehthumbs_vista.db
67+
68+
# Folder config file
69+
Desktop.ini
70+
71+
# Recycle Bin used on file shares
72+
$RECYCLE.BIN/
73+
74+
# Thumbnails
75+
._*
76+
77+
# Files that might appear in the root of a volume
78+
.DocumentRevisions-V100
79+
.fseventsd
80+
.Spotlight-V100
81+
.TemporaryItems
82+
.Trashes
83+
.VolumeIcon.icns
84+
85+
# Yeoman storage
86+
.yo-rc.json

‎.travis.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
language: node_js
2+
cache:
3+
directories:
4+
- ~/.npm
5+
notifications:
6+
email: false
7+
node_js:
8+
- '9'
9+
- '8'
10+
- '6'
11+
after_success:
12+
- npm run semantic-release
13+
branches:
14+
except:
15+
- /^v\d+\.\d+\.\d+$/

‎CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team leader at [`adrian@adrianperez.org`]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at
73+
https://www.contributor-covenant.org/version/1/4/code-of-conduct/
74+
75+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute!
4+
5+
**Working on your first Pull Request?** You can learn how from this _free_
6+
series [How to Contribute to an Open Source Project on GitHub][egghead]
7+
8+
## Project setup
9+
10+
1. Fork and clone the repo
11+
2. `$ yarn` to install dependencies
12+
3. `$ yarn test` to validate you've got it working
13+
4. Create a branch for your PR
14+
15+
> Tip: Keep your `master` branch pointing at the original repository and make
16+
> pull requests from branches on your fork. To do this, run:
17+
>
18+
> ```
19+
> git remote add upstream https://github.com/blackxored/commitlint-config-conventional-system.git
20+
> git fetch upstream
21+
> git branch --set-upstream-to=upstream/master master
22+
> ```
23+
>
24+
> This will add the original repository as a "remote" called "upstream," Then
25+
> fetch the git information from that remote, then set your local `master`
26+
> branch to use the upstream master branch whenever you run `git pull`. Then you
27+
> can make all of your pull request branches based on this `master` branch.
28+
> Whenever you want to update your version of `master`, do a regular `git pull`.
29+
30+
## Add yourself as a contributor
31+
32+
This project follows the [all contributors][all-contributors] specification. To
33+
add yourself to the table of contributors on the README.md, please use the
34+
automated script as part of your PR:
35+
36+
```console
37+
yarn run contributors:add
38+
```
39+
40+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. If
41+
you've already added yourself to the list and are making a new type of
42+
contribution, you can run it again and select the added contribution type.
43+
44+
## Committing and Pushing changes
45+
46+
This project uses [`semantic-release`][semantic-release] to do automatic
47+
releases and generate a changelog based on the commit history. So we follow [a
48+
convention][convention] for commit messages. You don't have to follow this
49+
convention if you don't like to, although we've provided hooks to make it easier
50+
for you to adhere to them if you so choose. Just know that when we merge your
51+
commit, we'll probably use "Squash and Merge" so we can change the commit
52+
message :)
53+
54+
Please make sure to run the tests before you commit your changes. You can run
55+
`npm test -- -u` which will update any snapshots that need updating. Make sure
56+
to include those changes (if they exist) in your commit.
57+
58+
## Help needed
59+
60+
Please checkout the [the open issues][issues]
61+
62+
Also, please watch the repo and respond to questions/bug reports/feature
63+
requests! Thanks!
64+
65+
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
66+
[semantic-release]: https://npmjs.com/package/semantic-release
67+
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
68+
[all-contributors]: https://github.com/kentcdodds/all-contributors
69+
[issues]: https://github.com/blackxored/commitlint-config-conventional-system/issues

0 commit comments

Comments
 (0)