Skip to content

Latest commit

History

History
43 lines (24 loc) 路 2.33 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) 路 2.33 KB

Contribute

Introduction

First, thank you for considering contributing to Slapdash Commands! 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

  • Marketing: writing blog posts, how-tos and printing stickers

  • Community: presenting the project at meetups and 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 too. You can support this project and transfer BTC to this address.

      bc1qgwar7xmpsed3qaq0fvf08qxmyvd40t8t9tnaf4
    

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 into 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.

Questions

If you require technical assistance, Stackoverflow is usually the best place to start. You can also create an issue (pro-tip: do a quick search first to see if someone else didn't ask the same question before!).

Credits

Contributors

Thank you to all the people who have already contributed to Slapdash Commands!

Backers

Thank you to all our backers!