Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 2.02 KB

Contributing

Note: This is just a personal project, so I don't expect contributions. That said, I'm open to all suggestions.

Hey there, and thanks for your help. Please adhere to the Code of Conduct (be a mensch).

There are a couple ways to get started. You can submit bug reports or feature requests, or work on existing bugs/features by claiming an issue. If you have any questions, reach out to me.

Bugs

If you noticed a bug, please submit a bug report. Include as much information as you think might be helpful (eg. screenshots, browser version, related issues). Remember that GitHub doesn't limit the number of characters, so you can add whatever you think is necessary.

Make sure that you can recreate the bug in a fresh repository, or it'll be hard to help you. If you can, create and link to a GitHub repository that maintainers can use to debug your issue.

Feature Requests

When there's something you want added, check the issues log. If there's already an issue, but it's inactive, give it a nudge by commenting. Otherwise, open a new issue explaining what you want addded/changed and why it's important to you. Think about both the solution, and why that solution is necessary.

Claiming an Issue

Browse through open issues. Once you've found one that you like, go ahead and leave a comment saying you're working on the issue. You can comment to ask for help as well.

When you're finished, open a pull request. Every pull request should correspond to an open issue (except for typos). Even if you already made the changes, you can create a draft pull request instead, and open an issue.