Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

55 lines (46 loc) · 2.78 KB
Raw

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!

  1. Find an issue that you are interested in addressing or a feature that you would like to add.

  2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name.

  3. Clone the repository to your local machine using: git clone https://github.com/github-username/repository-name.git.

  4. Add the upstream remote: git remote add upstream https://github.com/pushkaraj2007/TechCreators.git

  5. Pull the latest changes from the main repository if you think your fork is behind: git pull upstream main

  6. Create a new branch and switch to it for your issue fix or feature using: git switch -c branch-name-here

  7. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.

  8. Add the changes to the staging are and commit them to the branch you are working on.

  9. Push the changes to the remote repository using: git push origin branch-name-here.

  10. Submit a pull request to the upstream repository.

  11. Title the pull request with a short description of the changes made.

  12. Wait for the pull request to be reviewed by a maintainer.

  13. Make changes to the pull request if the reviewing maintainer recommends them.

  14. Celebrate your success after your pull request is merged! 🎉

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
Branch: feat/<branch-name>
Commits: feat: <commit-message>

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

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