Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 2.78 KB
Raw

Contributing

All contributions to the project (bug/feature reports, pull requests) are very welcome and appreciated! To make sure your work will be as useful as possible, make sure you follow these guidelines:

Issues - Bug Reports & Feature Requests

  • Before submitting an issue, search existing ones to see if there isn't one already open, so you aren't creating duplicates. If there is already an open issue for your case, simply comment on it to add your voice to the discussion.
  • Make sure to include closed issues in your search. Although you may want to open a new one regardless, linking the old discussions (using GitHub hashtag syntax, e.g. #1025) can be very helpful.
  • Give your issue a clear and descriptive title. Good title examples: Parasite trashes ice too early if the ice has additional strength (e.g. Meru Mati), Trashing ICE during a run should update the run position. Bad title examples: nice feature to have, Gabriel bug, rezzing doesn't work, a few suggestions
  • Following on the last example from the previous point - limit your reports to one bug/feature request per issue. If you have more ideas, just create more issues. Dealing with issues called some bugs I found or a few suggestions for the site isn't pleasant and lessens the likelihood of your voice to be heard.
  • If your issue is connected to a specific card's behavior, check out the card's notes in the card implementation status sheet. The problem may be already known and noted or the card may be unimplemented at all.
  • When reporting a bug, clear reproduction steps, screenshots and a description of your environment (used browser, operating system, etc.) all help a ton with bugfixing. Please provide them if possible!

Pull Requests - Code & Art Contributions

  • Do not add your IDE's project files to project's gitignore - add them to your local .gitignore instead. See this section for more info.
  • The Clojure files in this project try to follow the Clojure Style Guide, albeit loosely. Try to make sure your code complies with the guidelines.
  • A clear title and description of the changes (plus screenshots, if applicable) in Pull Request go a long way toward speeding up the PR's review and acceptance process.
  • To learn how to close GitHub issues with PR's or commit's messages, read this guide on GitHub.
  • If you are just starting out, check out our development guide - you may find a few things that are useful there.