summaryrefslogtreecommitdiff
path: root/CONTRIBUTION.md
diff options
context:
space:
mode:
authoranjalijaiswal082019-06-10 15:54:56 +0530
committeranjalijaiswal082019-06-12 13:01:32 +0530
commit880f6eaa02416aacbc732728a91c7025841ea2e5 (patch)
tree036a465b610d2a169627df4bf9ade96793b5488c /CONTRIBUTION.md
parent19e57ec09fc6ddb8e1462ebc118841207497109b (diff)
downloadeSim-880f6eaa02416aacbc732728a91c7025841ea2e5.tar.gz
eSim-880f6eaa02416aacbc732728a91c7025841ea2e5.tar.bz2
eSim-880f6eaa02416aacbc732728a91c7025841ea2e5.zip
Fixes issue 79 - Improved README and added CONTRIBUTION
Diffstat (limited to 'CONTRIBUTION.md')
-rw-r--r--CONTRIBUTION.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 00000000..a46bf859
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,24 @@
+## Contribution
+If you want to add any enhancement feature or have found any bug and want to work on it, please open a new issue regarding that and put a message "I would like to work on it." And make sure every pull request should reference to an issue.
+
+#### Points on how to make pull request
+* You need to fork this repository to your account.
+
+* Clone it using ``` git clone https://github.com/[username]/eSim.git ```
+
+* Always create a new branch before making any changes. You can create new branch using ```git branch <branch-name> ```
+
+* Checkout into your new branch using ```git checkout <branch-name>```
+
+* Make changes to code and once you are done use ```git add <path to file changed or added>```. Now commit changes with proper message using ```git commit -m "Your message"```.
+
+* After commiting your changes push your changes to your forked repository using ```git push origin <branch-name>```
+Finally create a pull request from github.
+There should be only one commit per pull request.
+
+
+* Please follow below guidelines for your commit message :
+ * Commit message should be like : Fixes issue #[issue_number] - one line message of work you did.
+ * After commit message, there should be a commit body where you can mention what you did in short or in detail.
+
+Please follow above method to file pull requests.