Skip to content

Latest commit

 

History

History
173 lines (116 loc) · 5.1 KB

CONTRIBUTING.md

File metadata and controls

173 lines (116 loc) · 5.1 KB

GUIDELINES FOR CONTRIBUTING

When contributing to this repository, please first discuss the change you wish to make via issue, discord, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

References

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

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 contribution is all about.

How to rebase a branch:

1. Fork the project.

2. Clone the forked repository. Open git bash and type:

git clone https://github.com/<your-github-username>/<the-project-name>.git

3. Navigate to the project directory.

cd <the-project-name>

4. Add upstream.

git remote add upstream https://github.com/Tech-Matrix/<the-project-name>

5. Check if the upstream is added or not.

git remote -v

6. If you cloned a while ago, get the latest changes from upstream.

git checkout <main>
git pull upstream <main>

7. Make a feature branch(Always check your current branch is up to date before creating a new branch from it to avoid merge conflicts)

git checkout -b <branch-name>

8. Locally merge (or rebase) the upstream master branch into your topic branch:

git pull [--rebase] upstream <main>

9. Push your local commits to the remote repo.

git push origin <branch-name>

10. Create a PR !

HOW TO MAKE A PULL REQUEST:

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

2. Clone the forked repository. Open terminal and type:

git clone https://github.com/<your-github-username>/<the-project-name>.git

3. Navigate to the project directory.

cd <the-project-name>

4. Make a feature branch

git checkout -b <branch-name>

Branch should ideally be named as: <github-username>/issueNumber/issueDescription Example: A-HK/i2/contributing-guidelines

5. Make changes in source code/ project.

6. Stage your changes and commit

#Add changes to Index
git add .

#Commit to the local repo
git commit --signoff -m "<your_commit_message>"

Please ensure that the commit messages follow these conventions

7. Push your local commits to the remote repo.

git push origin <branch-name>

8. Create a PR !

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

After this, project admins / mentors will review the changes and will merge your PR if found satisfactory, otherwise the required changes will be suggested.

Commit Conventions

Each commit message must ideally adhere to the following format:

<type>(scope): <description> - <issue number>

[optional body]

This improves the readability of the messages

Type

It can be one of the following:

  1. feat: Addition of a new feature
  2. fix: Bug fix
  3. docs: Documentation Changes
  4. style: Changes to styling
  5. refactor: Refactoring of code
  6. perf: Code that affects performance
  7. test: Updating or improving the current tests
  8. build: Changes to Build process
  9. revert: Reverting to a previous commit
  10. chore : updating grunt tasks etc

If there is a breaking change in your Pull Request, please add BREAKING CHANGE in the optional body section

Scope

The file or folder where the changes are made. If there are more than one, you can mention any

Description

A short description of the issue

Issue number

The issue fixed by this Pull Request.

The body is optional. It may contain short description of changes made.

Following all the guidelines an ideal commit will look like:

    git commit --signoff -m "docs: Contributing guidelines - #2"