๐๐ First off, thanks for taking the time to contribute! ๐๐
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itch.io.
The following is a set of guidelines for contributing to itch. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
- You can create an issue here,
but before doing that please read the notes below and include as many details as
possible with your report. If you can, please include:
- The version of itch you are using (you can find this in the "Advanced" section of the Preferences menu)
- The operating system you are using and version
- If applicable, what you were doing when the issue arose and what you expected to happen
- Other things that will help resolve your issue:
- Screenshots and animated GIFs
- Error output that appears in your terminal, dev tools or as an alert
- Perform a cursory search to see if a similar issue has already been submitted
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the coding style defined in docs.
- Write documentation in Markdown.
- Use short, present tense commit messages. See Commit Message Styleguide.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- When only changing documentation, include
[ci skip]in the commit description - Consider starting the commit message with an applicable emoji:
- ๐จ
:art:when improving the format/structure of the code - ๐
:racehorse:when improving performance - ๐
:clap:when improving user experience - ๐ฑ
:non-potable_water:when plugging memory leaks - ๐
:memo:when writing docs - ๐ง
:penguin:when fixing something on Linux - ๐
:apple:when fixing something on Mac OS - ๐
:checkered_flag:when fixing something on Windows - ๐
:bug:when fixing a bug - ๐ฅ
:fire:when removing code or files - ๐
:green_heart:when fixing the CI build - โ
:white_check_mark:when adding tests - ๐
:lock:when dealing with security - โฌ๏ธ
:arrow_up:when upgrading dependencies - โฌ๏ธ
:arrow_down:when downgrading dependencies - ๐
:shirt:when removing linter warnings
- ๐จ