Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 4.93 KB

CONTRIBUTING.md

File metadata and controls

70 lines (42 loc) · 4.93 KB

Contribute

Introduction

First, thank you for considering contributing to JavaScript Enhancements! 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 (e.g. screenshots with the console open)
  • Marketing: writing blog posts, howto's, videos, ...
  • 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 Open Collective, Patreon or using PayPal.

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. Please, before submit it, run the tests using the UnitTesting Sublime Text package (in this case you need to install manually also this package: Keypress). The description should explain what the code does and give steps to execute it. If necessary, the description should also contain screenshots showing up the new behaviour. The pull request should also contain tests. When you are changing the code of this plugin, I recommend to use AutomaticPackageReloader to test quickly the new changes. It automatically reload submodules while developing a Sublime Text package without the need of reopening the editor.

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?

Issues/Questions

If you have any problems, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!). For small questions, you can use Gitter.

Email me for any questions or doubts about this project on: pichillilorenzo@gmail.com

Feature request/enhancement

For feature requests/enhancement, create an issue or use Gitter.

Financial contributions

If this project helps you reduce time to develop and also you like it, please support it with a donation on Patreon, Open Collective or using PayPal 😄👍. Thanks!

paypal Become a Patron opencollective

Credits

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].