Skip to content

Commit 7d126f9

Browse files
z0alz0al
committed
chore: initial commit
0 parents  commit 7d126f9

File tree

12 files changed

+523
-0
lines changed

12 files changed

+523
-0
lines changed

‎.env.example

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# The ID of your GitHub App
2+
APP_ID=
3+
WEBHOOK_SECRET=development
4+
5+
# Uncomment this to get verbose logging
6+
# LOG_LEVEL=trace # or `info` to show less
7+
8+
# Subdomain to use for localtunnel server. Defaults to your local username.
9+
# SUBDOMAIN=

‎.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules
2+
npm-debug.log
3+
*.pem
4+
.env
5+
package-lock.json

‎.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sudo: false
2+
language: node_js
3+
node_js:
4+
- "7.7.1"
5+
notifications:
6+
disabled: true

‎CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Contributing
2+
3+
[fork]: /fork
4+
[pr]: /compare
5+
[style]: https://standardjs.com/
6+
[code-of-conduct]: CODE_OF_CONDUCT.md
7+
8+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9+
10+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
11+
12+
## Submitting a pull request
13+
14+
1. [Fork][fork] and clone the repository
15+
1. Configure and install the dependencies: `npm install`
16+
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so no need to lint seperately
17+
1. Create a new branch: `git checkout -b my-branch-name`
18+
1. Make your change, add tests, and make sure the tests still pass
19+
1. Push to your fork and [submit a pull request][pr]
20+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
21+
22+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
23+
24+
- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`
25+
- Write and update tests.
26+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
27+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
28+
29+
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.
30+
31+
## Resources
32+
33+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
34+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
35+
- [GitHub Help](https://help.github.com)

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017-present Ahmed T. Ali <[email protected]> (https://commitlint.now.sh)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# commitlint-bot
2+
3+
<p align="center">
4+
<img src="docs/robot.svg" alt="commitlint-bot logo" />
5+
</p>
6+
7+
> Built with [probot](https://github.com/probot/probot) framework
8+
9+
A GitHub App that runs [commitlint](https://github.com/marionebl/commitlint) over all commits of new or edited pull requests
10+
and sets an appropriate status check.
11+
12+
## Development
13+
14+
```
15+
# Install dependencies
16+
npm install
17+
18+
# Run the bot
19+
npm start
20+
```
21+
22+
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.
23+
24+
25+
## Credits
26+
27+
Robot designed by [Freepik](https://www.freepik.com/free-vector/fun-pack-of-robots-avatars_1258314.htm).
28+
29+
## License
30+
31+
Released under the [MIT license](./LICENSE).

‎app.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"env": {
3+
"PRIVATE_KEY": {
4+
"description": "the private key you downloaded when creating the GitHub App"
5+
},
6+
"APP_ID": {
7+
"description": "the ID of your GitHub App"
8+
},
9+
"WEBHOOK_SECRET": {
10+
"description": "the secret configured for your GitHub App"
11+
}
12+
}
13+
}

‎docs/deploy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Deploying
2+
3+
If you would like to run your own instance of this app, see the [docs for deployment](https://probot.github.io/docs/deployment/).
4+
5+
This app requires these **Permissions & events** for the GitHub App:
6+
7+
> **TODO**: List permissions required for deployment here. See [probot/stale](https://github.com/probot/stale/blob/master/docs/deploy.md) for an example.

0 commit comments

Comments
 (0)