mirror of
https://github.com/Raghu-Ch/angular-challenges.git
synced 2026-02-10 04:43:03 -05:00
feat(core): add contributing file and verif
This commit is contained in:
4
.husky/commit-msg
Executable file
4
.husky/commit-msg
Executable file
@@ -0,0 +1,4 @@
|
||||
#!/usr/bin/env sh
|
||||
. "$(dirname -- "$0")/_/husky.sh"
|
||||
|
||||
npx --no -- commitlint --edit ${1}
|
||||
4
.husky/pre-commit
Executable file
4
.husky/pre-commit
Executable file
@@ -0,0 +1,4 @@
|
||||
#!/usr/bin/env sh
|
||||
. "$(dirname -- "$0")/_/husky.sh"
|
||||
|
||||
npx lint-staged
|
||||
41
CONTRIBUTING.README.md
Normal file
41
CONTRIBUTING.README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
<!-- TODO: add title of your exercice -->
|
||||
<h1>{Title of your exercice}</h1>
|
||||
|
||||
<!-- TODO: Add your name -->
|
||||
|
||||
> Author: {Your name}
|
||||
|
||||
<!-- TODO: add Information/Statement/Rules/Constraint/Steps -->
|
||||
|
||||
### Information
|
||||
|
||||
### Statement
|
||||
|
||||
### Step 1
|
||||
|
||||
### Step 2
|
||||
|
||||
### Constraints:
|
||||
|
||||
### Submitting your work
|
||||
|
||||
1. Fork the project
|
||||
2. clone it
|
||||
3. npm install
|
||||
<!-- TODO: add you project app name directory -->
|
||||
4. **nx serve {{project app name}}**
|
||||
5. _...work on it_
|
||||
6. Commit your work
|
||||
<!-- TODO: add your challenge number -->
|
||||
7. Submit a PR with a title beginning with **Answer:{challenge number}** that I will review and other dev can review.
|
||||
|
||||
<!-- TODO: add challenge number and project Name -->
|
||||
|
||||
<a href="https://github.com/tomalaforge/angular-challenges/pulls?q=label%3A{challenge number}+label%3Aanswer"><img src="https://img.shields.io/badge/-Solutions-green" alt="{Project name}"/></a>
|
||||
|
||||
<!-- TODO: uncomment when done late -->
|
||||
<!-- <a href='https://github.com/tomalaforge/angular-challenges/pulls?q=label%3A{challenge number}+label%3A"answer+author"'><img src="https://img.shields.io/badge/-Author solution-important" alt="{Project name} solution author"/></a>
|
||||
<a href="{Blog post url}" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/-Blog post explanation-blue" alt="{Project name} blog article"/></a> -->
|
||||
|
||||
<!-- TODO: you can add your twitter or anything else if you wish -->
|
||||
<!-- _You can ask any question on_ <a href="https://twitter.com/laforge_toma" target="_blank" rel="noopener noreferrer"><img src="./../../logo/twitter.svg" height=20px alt="twitter"/></a> -->
|
||||
22
CONTRIBUTING.md
Normal file
22
CONTRIBUTING.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Contributing
|
||||
|
||||
> Thank you for considering contributing to this project. Your help is very much appreciated!
|
||||
|
||||
When contributing, it's better to first explain the challenge/exercice you are thinking about in the issue tab.
|
||||
|
||||
## Getting started
|
||||
|
||||
Please follow those step in order to succesfully make your contribution to this repository.
|
||||
|
||||
1. Fork the project
|
||||
2. Install **Nx Console**, this will help you work with this repository
|
||||
3. Run `npm ci` to install all dependencies
|
||||
4. Generate a new app with Nx Console > Right Click on apps folder > `Nx Generate Application`
|
||||
5. Copy/Paste **CONTRIBUTING.README.md** and fill it up.
|
||||
6. Link the main **README** with your new challenge
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
|
||||
in our commit messages, i.e. `feat(core): improve typing`
|
||||
2. When you are ready, create Pull Request of your fork into original repository with the title starting with **NEW CHALLENGE**
|
||||
1
commitlint.config.js
Normal file
1
commitlint.config.js
Normal file
@@ -0,0 +1 @@
|
||||
module.exports = {extends: ['@commitlint/config-conventional']};
|
||||
2248
package-lock.json
generated
2248
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
12
package.json
12
package.json
@@ -7,7 +7,8 @@
|
||||
"postinstall": "node ./decorate-angular-cli.js",
|
||||
"start": "nx serve",
|
||||
"build": "nx build",
|
||||
"test": "nx test"
|
||||
"test": "nx test",
|
||||
"prepare": "husky install"
|
||||
},
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
@@ -41,6 +42,8 @@
|
||||
"@angular/cli": "~14.2.0",
|
||||
"@angular/compiler-cli": "~14.2.0",
|
||||
"@angular/language-service": "~14.2.0",
|
||||
"@commitlint/cli": "^17.2.0",
|
||||
"@commitlint/config-conventional": "^17.2.0",
|
||||
"@nrwl/cli": "15.0.7",
|
||||
"@nrwl/cypress": "15.0.7",
|
||||
"@nrwl/eslint-plugin-nx": "15.0.7",
|
||||
@@ -55,13 +58,20 @@
|
||||
"eslint": "~8.15.0",
|
||||
"eslint-config-prettier": "8.1.0",
|
||||
"eslint-plugin-cypress": "^2.10.3",
|
||||
"husky": "^8.0.2",
|
||||
"jest": "28.1.1",
|
||||
"jest-environment-jsdom": "28.1.1",
|
||||
"jest-preset-angular": "~12.2.2",
|
||||
"lint-staged": "^13.0.3",
|
||||
"nx": "15.0.7",
|
||||
"prettier": "^2.6.2",
|
||||
"ts-jest": "28.0.5",
|
||||
"ts-node": "10.9.1",
|
||||
"typescript": "~4.8.2"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{ts,json,md}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user