Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: contributing documentation #15

Merged
merged 1 commit into from
Sep 27, 2022
Merged

docs: contributing documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing to TechCreators

First off, thank you for considering contributing to this project. This open source project is only possible because of amazing people like you.

Secondly, we'd like the contribution experience to be as good as possible. We are happy to hear feedback about your experience, and if we can make the docs or experience better please let us know.

## How do I make a contribution?
Never made an open source contribution before? No problem!

<ol>
<li> Find an <strong>issue</strong> that you are interested in addressing or a <strong>feature</strong> that you would like to add.</li>
<br>
<li>Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under <strong>your-GitHub-username/repository-name. </strong> </li>
<br>
<li>Clone the repository to your local machine using: <strong> git clone https://github.com/github-username/repository-name.git. </strong></li>
<br>
<li>Add the upstream remote:<strong> git remote add upstream https://github.com/pushkaraj2007/TechCreators.git </strong> </li>
<br>
<li>Pull the latest changes from the main repository if you think your fork is behind: <strong> git pull upstream main </strong> </li>
<br>
<li>Create a new branch and switch to it for your issue fix or feature using: <strong> git switch -c branch-name-here </strong> </li>
<br>
<li>Make the appropriate changes for the issue you are trying to address or the feature that you want to add.</li>
<br>
<li>Add the changes to the staging are and commit them to the branch you are working on.</li>
<br>
<li>Push the changes to the remote repository using: <strong>git push origin branch-name-here.</strong></li>
<br>
<li>Submit a pull request to the upstream repository.</li>
<br>
<li>Title the pull request with a short description of the changes made.</li>
<br>
<li>Wait for the pull request to be reviewed by a maintainer.</li>
<br>
<li>Make changes to the pull request if the reviewing maintainer recommends them.</li>
<br>
<li>Celebrate your success after your pull request is merged! 🎉</li>

</ol>

## How do I run this project?
To understand how this project works and how to run it we recommend you to read README.md file (https://github.com/pushkaraj2007/TechCreators/blob/main/README.md)

## Commit and Branch best pratices
To new features and implementations on source code <br/>
Branch: `feat/<branch-name>`<br/>
Commits: `feat: <commit-message>`<br/>

To improve docs, contributing file, and other related to developer experience <br/>
Branch: `docs/<branch-name>`<br/>
Commits: `docs: <commit-message>`<br/>

To fix bugs on the source code <br/>
Branch: `fix/<branch-name>`<br/>
Commits: `fix: <commit-message>`<br/>