Skip to content

Commit 16a0556

Browse files
committed
feat(core): add contributing file and verif
1 parent e2edf99 commit 16a0556

7 files changed

+2463
-133
lines changed

.husky/commit-msg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx --no -- commitlint --edit ${1}

.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx lint-staged

CONTRIBUTING.README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- TODO: add title of your exercice -->
2+
<h1>{Title of your exercice}</h1>
3+
4+
<!-- TODO: Add your name -->
5+
6+
> Author: {Your name}
7+
8+
<!-- TODO: add Information/Statement/Rules/Constraint/Steps -->
9+
10+
### Information
11+
12+
### Statement
13+
14+
### Step 1
15+
16+
### Step 2
17+
18+
### Constraints:
19+
20+
### Submitting your work
21+
22+
1. Fork the project
23+
2. clone it
24+
3. npm install
25+
<!-- TODO: add you project app name directory -->
26+
4. **nx serve {{project app name}}**
27+
5. _...work on it_
28+
6. Commit your work
29+
<!-- TODO: add your challenge number -->
30+
7. Submit a PR with a title beginning with **Answer:{challenge number}** that I will review and other dev can review.
31+
32+
<!-- TODO: add challenge number and project Name -->
33+
34+
<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>
35+
36+
<!-- TODO: uncomment when done late -->
37+
<!-- <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>
38+
<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> -->
39+
40+
<!-- TODO: you can add your twitter or anything else if you wish -->
41+
<!-- _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> -->

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
> Thank you for considering contributing to this project. Your help is very much appreciated!
4+
5+
When contributing, it's better to first explain the challenge/exercice you are thinking about in the issue tab.
6+
7+
## Getting started
8+
9+
Please follow those step in order to succesfully make your contribution to this repository.
10+
11+
1. Fork the project
12+
2. Install **Nx Console**, this will help you work with this repository
13+
3. Run `npm ci` to install all dependencies
14+
4. Generate a new app with Nx Console > Right Click on apps folder > `Nx Generate Application`
15+
5. Copy/Paste **CONTRIBUTING.README.md** and fill it up.
16+
6. Link the main **README** with your new challenge
17+
18+
## Pull Request Process
19+
20+
1. We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
21+
in our commit messages, i.e. `feat(core): improve typing`
22+
2. When you are ready, create Pull Request of your fork into original repository with the title starting with **NEW CHALLENGE**

commitlint.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {extends: ['@commitlint/config-conventional']};

0 commit comments

Comments
 (0)