CONTRIBUTING.md

How to contribute to jinx-the-robot

Did you find a bug?

• Ensure the bug was not already reported by searching the existing issues.

• If you're unable to find an open issue addressing the problem, open a new one. Include as many details as possible. Fill out the required template; the information it asks for will help us resolve issues faster.

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

• Before submitting, please read the Code Style Guide to know more about coding conventions.

Do you intend to add a new feature or change an existing one?

• Suggest your change as a new issue and start writing code. Make it clear in the title of the issue that this is a feature and not a bug.

Code Style Guide

• Four spaces, no tabs (for indentation).
• No trailing whitespace. Blank lines should not have any spaces.
• Use ECMAScript 6 / ECMAScript 2017 syntax conventions where possible, including:
  • Arrow functions
  • Block-level scoping via let and const
  • Default parameters
  • Destructuring assignment
  • Object literal shorthand for properties and methods
  • Spread syntax for array/string expansion
• Use ESLint for static code analysis and to follow the Isotropic project code guidelines, which are used for jinx-the-robot as well.
• When in doubt, follow the conventions of the code used elsewhere in the project.

jinx-the-robot is a volunteer effort. If you do decide to contribute, thank you for your interest and your time! ❤️ ❤️ ❤️