From 246b646e6979c82ba3efb4ebd94d5e2cb019dfee Mon Sep 17 00:00:00 2001 From: Rudraksh Karpe Date: Thu, 5 Oct 2023 03:04:16 +0530 Subject: [PATCH] docs: updated CONTRIBUTING.md guildlines - Fixed minor errors in previous CONTRIBUTING.md - Updated commit message conventions --- CONTRIBUTING.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f71982..9687243 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,11 +31,33 @@ You can see what all you changes using the `git status` command. ## 4. Add all you changes Add all your changes to you branch using the `git add .` command +## 5. Commit your changes +Commit your changes to your branch using `git commit -m "commit message"` command. + +## Commit Message Conventions + +- Start with a short summary (50 characters or less) of the changes made. +- Use the present tense and imperative mood. +- Separate the summary from the body of the message with a blank line. +- Use the body to explain what and why changes were made, as well as any necessary details. +- Additionally, you can consider using [semantic commit messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716?permalink_comment_id=3867882) like "feat:", "docs:", etc. which will provide additional context to the commit message. + +| Commit Type | Description | +| ---- | ---- | +| `feat` | New feature or functionality added | +| `fix` | Bug fix | +| `docs` | Changes to documentation | +| `test` | Adding or updating tests | +| `chore` | Maintenance tasks such as refactoring, dependencies updates, or removing unused code | +| `ci` | Changes to the build or continuous integration process | + ## 5. Push you changes to GitHub -Switch to the main branch using this command: +Switch to the master branch using this command: ```git checkout master``` Push all your changes to GitHub using the command: ```git push --set-upstream origin ``` + +