Skip to content

Commit 48d36aa

Browse files
author
Nabeel Shakeel
committed
docs: update repo README with project instruction
1 parent dc2dd33 commit 48d36aa

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,27 @@
2626

2727
<br />
2828

29-
* **Pull Request Template**: Create pull request template for features and bugs
30-
* **Issue Template**: Create issue template for feature requests and bug reports
31-
* **Contributing Guide**: Create contributing guidelines for a project
29+
- **Pull Request Template**: Create pull request template for features and bugs
30+
- **Issue Template**: Create issue template for feature requests and bug reports
31+
- **Contributing Guide**: Create contributing guidelines for a project
3232

3333
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
3434

35-
## Install
35+
## Usage
3636

37-
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
37+
Run the command in the root directory of the project
3838

39-
## Usage
39+
`npx repo-checklist`
4040

41-
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
41+
It will launch a interactive UI that guides you through adding Repo Community Standard by simply typing `yes` to add in your project and `no` to skip it.
4242

43-
## Examples
43+
Generated files on the following paths
44+
45+
- Pull Request Template: `<your_project_roor>/.github/PULL_REQUEST_TEMPLATE.md`
46+
- Contributing Guide: `<your_project_roor>/CONTRIBUTING.md`
47+
- Issue Template
48+
- Feature: `<your_project_roor>/.github/ISSUE_TEMPLATE/FEATURE.yml`
49+
- Fix: `<your_project_roor>/.github/ISSUE_TEMPLATE/FIX.yml`
4450

4551
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
4652

@@ -51,9 +57,11 @@
5157
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
5258

5359
## Star
60+
5461
Don't forget to hit the ⭐, If you like this repository.
5562

5663
![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
5764

5865
## License
66+
5967
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)