Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 6.59 KB

CONTRIBUTING.md

File metadata and controls

110 lines (80 loc) · 6.59 KB
Raw

Contributing to this repository

Getting started

Before you begin:

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

Fork using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Fork with GitHub Codespaces:

Open a pull request

When you're done making changes, and you'd like to propose them for review, use the pull request template to open your PR (pull request).

Submit your PR & get it reviewed

  • Once you submit your PR, other users from the community will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions. Check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out our git tutorial on resolving merge conflicts and other issues.

Your PR is merged!

Congratulations! The whole GitHub community thanks you. ✨

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.

Keep contributing as you use GitHub Docs

Now that you're a part of the GitHub Docs community, you can keep participating in many ways.

Learn more about contributing:

Types of contributions 📝

You can contribute to the Twitch-Channel-Points-Miner-v2 in several ways. Bug reporting, pull request, propose new features, fork, donate, and much more 💪 .

🪲 Issues

Issues are used to report a bug, propose new features, or ask for help. When you open an issue, please use the appropriate template and label.

🛠️ Pull requests

A pull request is a way to suggest changes in our repository.

When we merge those changes, they should be deployed to the live site within 24 hours. 🌍 To learn more about opening a pull request in this repo, see Opening a pull request below.

Starting with an issue

You can browse existing issues to find something that needs help!

Labels

Labels can help you find an issue you'd like to help with.

  • The bug label is used when something isn't working
  • The documentation label is used when you suggest improvements or additions to documentation (README.md update)
  • The duplicate label is used when this issue or pull request already exists
  • The enhancement label is used when you ask for / or propose a new feature or request
  • The help wanted is used when you need help with something
  • The improvements label is used when you would suggest improvements on already existing features
  • The invalid label is used for a non-valid issue
  • The question label is used for further information is requested
  • The wontfix label is used if we will not work on it

Opening a pull request

You can use the GitHub user interface ✏️ for minor changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally to view changes and run your tests on your machine.

Self review

You should always review your own PR first.

For content changes, make sure that you:

  • Confirm that the changes address every part of the content design plan from your issue (if there are differences, explain them).
  • Review the content for technical accuracy.
  • Review the entire pull request using the checklist present in the template.
  • Copy-edit the changes for grammar, spelling, and adherence to the style guide.
  • Check new or updated Liquid statements to confirm that versioning is correct.
  • Check that all of your changes render correctly in staging. Remember, that lists and tables can be tricky.
  • If there are any failing checks in your PR, troubleshoot them until they're all passing.

Pull request template

When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.

Python Styleguide

All Python code is formatted with Black using the default settings. Your code will not be accepted if it is not blackened. You can use the pre-commit hook.

pip install pre-commit
pre-commit install

Suggested changes

We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

As you update your PR and apply changes, mark each conversation as resolved.