mirror of
https://github.com/hastagAB/Awesome-Python-Scripts.git
synced 2024-11-23 20:11:07 +00:00
docs: updated CONTRIBUTING.md guildlines
- Fixed minor errors in previous CONTRIBUTING.md - Updated commit message conventions
This commit is contained in:
parent
f37e445103
commit
246b646e69
|
@ -31,11 +31,33 @@ You can see what all you changes using the `git status` command.
|
||||||
## 4. Add all you changes
|
## 4. Add all you changes
|
||||||
Add all your changes to you branch using the `git add .` command
|
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
|
## 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```
|
```git checkout master```
|
||||||
|
|
||||||
Push all your changes to GitHub using the command:
|
Push all your changes to GitHub using the command:
|
||||||
|
|
||||||
```git push --set-upstream origin <your_branch_name>```
|
```git push --set-upstream origin <your_branch_name>```
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user