diff options
author | rahulp13 | 2021-01-08 00:46:16 +0530 |
---|---|---|
committer | rahulp13 | 2021-01-08 00:46:16 +0530 |
commit | 6536595225331febcb60422a8b8d2dde1520c982 (patch) | |
tree | a6f0555a090358ec2619f1ed48995ebdfaf682db /CONTRIBUTION.md | |
parent | af4fe5b34e291cfe3bb1dadb967a8a049bf9ee64 (diff) | |
download | nghdl-6536595225331febcb60422a8b8d2dde1520c982.tar.gz nghdl-6536595225331febcb60422a8b8d2dde1520c982.tar.bz2 nghdl-6536595225331febcb60422a8b8d2dde1520c982.zip |
update readme
Diffstat (limited to 'CONTRIBUTION.md')
-rw-r--r-- | CONTRIBUTION.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..dec42e8 --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,25 @@ +## 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/FOSSEE/nghdl.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. |