Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.39 KB
Raw

Contributing

Any change matters, whatever the size, just do it.

Contributions are always welcome, no matter how large or small! Before contributing, please read the code of conduct.

How Do I Contribute?

There are different ways to contribute, each comes with a different levels of tasks, such as:

  • Report a bug.
  • Request a feature you think would be great for the plugin.
  • Take the ownership of the bug you want to fix and let others know about it by commenting on the issue.
  • Test and triage reported bugs by others.
  • Work on requested/approved features.
  • Improve the codebase (lint, naming, comments, test descriptions, etc...)
  • Improve the documentation.
  • Let the world know about the plugin!

Submitting a Pull Request

The following are the steps you should follow when creating a pull request. Subsequent pull requests only need to follow step 3 and beyond.

  1. Fork the repository on GitHub
  2. Clone the forked repository to your machine
  3. Make your changes and commit them to your local repository
  4. Rebase and push your commits to your GitHub remote fork/repository
  5. Issue a Pull Request to the official repository
  6. Your Pull Request is reviewed by a committer and merged into the repository

NOTE: While there are other ways to accomplish the steps using other tools, the examples here will assume most actions will be performed via git on command line.