Skip to content
This repository has been archived by the owner on Nov 28, 2021. It is now read-only.

Latest commit

 

History

History
86 lines (57 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

86 lines (57 loc) · 3.97 KB
Raw

🤝 First time contributing? We will help you out. 👍

GitHub custom open for collaboration

Refer to the following articles on the basics of Git and Github. You can also contact the Project Mentors, in case you are stuck:

If you don't have Git on your machine, install it.

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a branch for any Issue that you are working upon.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add screenshots to help us know what this script is all about.

⭐ HOW TO MAKE A PULL REQUEST:

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/stargate

3. Navigate to the project directory.

cd stargate

5. Create a new branch:

git checkout -b <YourBranchName>

6. Make changes in source code.

7. Stage your changes and commit

git add <file1,file2....>
git commit -m "<your_commit_message>"

8. Push your local commits to the remote repo.

git push origin <YourBranchName>

9. Create a Pull Request !

10. Congratulations! Sit and relax, you've made your contribution to the Stargate project.

🏆 After this, project leaders and mentors will review the changes and will merge your PR if they add value, or they will suggest any required changes.

📝 Style Guides for Git Commit Messages

Here's a list of some good to have points, that can add more value to your contribution logs.

  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
  • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
  • BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
  • types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refractor:, perf:, test:, and others.
  • footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.

For more detailed reference to the above points, refer here

💥 Issues:

For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.

All the Best!🥇