Skip to content

Commit

Permalink
Contribution guidelines added
Browse files Browse the repository at this point in the history
  • Loading branch information
saurabhdaware committed Sep 5, 2019
1 parent f0e2b15 commit eaa5dce
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Setting up local development
- [Fork the project](https://github.com/saurabhdaware/projectman/fork) using fork button in the top right corner.
- Clone the project to your device using `git clone https://github.com/{yourUsername}/projectman.git`
- `npm install` to install the required dependencies
- 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)
- Type `projectman open` to test your code.


## Directory Structure
There are two important folders that you should care about `lib` and `bin`
```
- lib
-> action.js // Contains all the main logic
-> settings.json // project path are stored here on running commands like 'pm add'
- bin
-> index.js // Main file, This file is triggered when `projectman` or `pm` is called
```

## Contribution Guidelines
- 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.
- If you need any help understanding the code you can reach out to me on twitter/[@saurabhcodes](https://twitter.com/saurabhcodes)

- For Contributing to this project or any project on GitHub
1. Fork project.
2. Create a branch with the name of feature that you're working on (e.g. 'better-add-command').
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)


## Coding Guidelines
- Please write comments wherever necessary.
- Write unit tests wherever possible.
- If you create a new file that exports various functions, put it inside `lib` folder
- Please write proper commit messages explaining your changess.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,11 @@ Please note that the settings will be rewrote everytime you update the package s

---

**Thank you for showing Interest! Do contribute to [projectman🦸 on GitHub](https://github.com/saurabhdaware/projectman)**
## Contributing to ProjectMan
[![contributions welcome to projectman](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/saurabhdaware/projectman/issues)

I would be extremely happy to have people contribute to ProjectMan. You can read Contribution guidelines in **[CONTRIBUTING.md](CONTRIBUTING.md)**

---

**Thank you for showing Interest! Do contribute and star to [ProjectMan🦸 on GitHub](https://github.com/saurabhdaware/projectman)**

0 comments on commit eaa5dce

Please sign in to comment.