Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

48 lines (27 loc) · 2.95 KB
Raw

Contributing Guidelines

Pull requests, bug reports, and feature requests are welcomed and highly encouraged!

Contents

📖 General Guidelines

For everything from pull requests, bug reports, features requests and code reviews the following applies:

Be respectful of each other! Abusive language or harassment is not welcome here!

💡 Questions

If you have any questions regarding the code in this project or the p4nth3rworld game itself, ask in The Claw Discord or whitep4nth3r's twitch chat. Please do not open issues for questions about how to play the game.

📥 Opening an Issue

If you find any issues with the p4nth3rworld front end app or p4nth3rworld the game, we would love a well-written report!

  • Do not open a duplicate issue! Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.

  • The use of reactions instead of comments is preferred, if you simply want to "+1" an existing issue.

  • Provide as much information as you can. We don't have a bug report template, just be thorough with your report and if possible add some images. It's also very usefull to add your twitch username if it differs from your github one!

💌 Feature Requests

We very much welcome feature requests! But do keep in mind that not every feature can or should be added. Also we very much encourage you to create a pull request yourself! We have only a few people working on this project and would love the help!

  • Do not open a duplicate feature request. Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.

🔁 Submitting Pull Requests

We very much welcome pull requests, and as previously mentioned, very much encourage people to create pull requests for features or issues they encountered themselves!

  • Make isolated changes. When making a pull request make sure that all the changes within it are solely about this one feature or bug fix. Do not include multiple issues or features.

Try to follow existing patterns in the existing code when submitting a pull request. PRs completely refactoring the whole code style of the project will not be accepted.