From eaa5dcec1dbf2c194c437858a1c0ea6125705293 Mon Sep 17 00:00:00 2001 From: Saurabh Daware Date: Thu, 5 Sep 2019 13:15:26 +0530 Subject: [PATCH] Contribution guidelines added --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ README.md | 9 ++++++++- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..533ee40 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index cce2b3f..a81d741 100644 --- a/README.md +++ b/README.md @@ -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)** \ No newline at end of file +## 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)** \ No newline at end of file