Skip to content

Commit eaa5dce

Browse files
committed
Contribution guidelines added
1 parent f0e2b15 commit eaa5dce

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Setting up local development
2+
- [Fork the project](https://github.com/saurabhdaware/projectman/fork) using fork button in the top right corner.
3+
- Clone the project to your device using `git clone https://github.com/{yourUsername}/projectman.git`
4+
- `npm install` to install the required dependencies
5+
- Type `npm link` to install the content in your global directory. (Your directory will be linked to your global node folder which means if you change anything in the directory it will change inside the global directory as well)
6+
- Type `projectman open` to test your code.
7+
8+
9+
## Directory Structure
10+
There are two important folders that you should care about `lib` and `bin`
11+
```
12+
- lib
13+
-> action.js // Contains all the main logic
14+
-> settings.json // project path are stored here on running commands like 'pm add'
15+
- bin
16+
-> index.js // Main file, This file is triggered when `projectman` or `pm` is called
17+
```
18+
19+
## Contribution Guidelines
20+
- If you're planning to implement a new feature I will recommend you to discuss with me before you start coding so you won't end up working on something that I don't want to implement. Create an Issue with proper name and content for discussion.
21+
- If you need any help understanding the code you can reach out to me on twitter/[@saurabhcodes](https://twitter.com/saurabhcodes)
22+
23+
- For Contributing to this project or any project on GitHub
24+
1. Fork project.
25+
2. Create a branch with the name of feature that you're working on (e.g. 'better-add-command').
26+
3. Once you're done coding create a merge request from your new branch to my master. (Read the Local Development section above for local setup guidelines)
27+
28+
29+
## Coding Guidelines
30+
- Please write comments wherever necessary.
31+
- Write unit tests wherever possible.
32+
- If you create a new file that exports various functions, put it inside `lib` folder
33+
- Please write proper commit messages explaining your changess.

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,11 @@ Please note that the settings will be rewrote everytime you update the package s
100100

101101
---
102102

103-
**Thank you for showing Interest! Do contribute to [projectman🦸 on GitHub](https://github.com/saurabhdaware/projectman)**
103+
## Contributing to ProjectMan
104+
[![contributions welcome to projectman](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/saurabhdaware/projectman/issues)
105+
106+
I would be extremely happy to have people contribute to ProjectMan. You can read Contribution guidelines in **[CONTRIBUTING.md](CONTRIBUTING.md)**
107+
108+
---
109+
110+
**Thank you for showing Interest! Do contribute and star to [ProjectMan🦸 on GitHub](https://github.com/saurabhdaware/projectman)**

0 commit comments

Comments
 (0)