Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

95 lines (66 loc) · 2.96 KB
Raw

Contributing

Thanks for contributing! 😄 We love contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Note: Contributions should be made via pull requests to the dev branch of the repository.

Table of Contents

  1. Styleguides
  2. What should I know before I get started?
  3. How Can I contribute?
  4. Code Contribution

Guidelines

The following are the guidelines we request you to follow in order to contribute to this project.

Styleguides

Commit Messages

The commit messages should follow the following pattern:

feat: Description # if a new feature is added
fix: Description # if a bug is fixed
refactor: Description # if code is refactored
docs: Description # if documentation is added
lint: Description # if a lint issue is fixed

Issues

update: Description # if an update is required for a feature
bug: Description # if there is a bug in a particular feature
suggestion: Description # if you want to suggest a better way to implement a feature

Code Styleguide

The code should satisfy the following:

  • Have meaningful variable names, either in snake_case or camelCase.
  • Have no lint issues.
  • Have meaningful file names, directory names and directory structure.
  • Have a scope for easy fixing, refactoring and scaling.

What should I know before I get started

You can contribute to any of the features you want, here's what you need to know:

  • How the project works.
  • The technology stack used for the project.
  • A brief idea about writing documentation.

How Can I Contribute

You can contribute by:

  • Reporting Bugs
  • Suggesting Enhancements
  • Code Contribution
  • Pull Requests

Code Contribution

  1. Checkout the latest main branch to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  2. Check the issue tracker to make sure someone already hasn't requested it and/or contributed to it.
  3. Fork it!
  4. Create your feature branch: git checkout -b feature/my-new-feature
  5. Add your changes: git add .
  6. Commit your changes: git commit -am 'feat: Add some feature'
  7. Push to the branch: git push -u origin feature/my-new-feature
  8. Submit a pull request 😎

Pull Requests

Make sure to document the contributions well in the pull request. Pull requests should have:

  • A concise commit message.
  • A description of what was changed/added.

Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.

It is not compulsory to follow the guidelines mentioned above, but it is strongly recommended.