Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 2.5 KB
Raw

Contribute

Introduction

First, thank you for considering contributing to this plugin! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help with

  • QA: file bug reports, the more details you can give the better (i.e. REPL-links or repos that demonstrate the specific issue)
  • Marketing: writing blog posts, howto's, printing stickers, ...
  • Community: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
  • Code: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
  • Money: we welcome financial contributions in full transparency on https://github.com/sponsors/shellscape

Your First Contribution

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Submitting Code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

Code Review Process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.

It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? Does it resolve any known Github issues? Adding a line "resolves #" (e.g. "resolves #23") to the description of your pull request or of a specific commit will automatically close this issue once the pull request is merged.

Financial Contributions and Sponsorship

If you find this project useful, please consider sponsoring it! https://github.com/sponsors/shellscape

Questions

If you require technical assistance, Stackoverflow or Gitter are usually the best places to start. You can also create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!).