Skim is open source. It's hosted, developed, and maintained only on GitHub.
Skim follows the fork-pull model and leverages issues and pull requests for source control, bug fixes, and new features. Anyone is welcome to submit a request, but I ask that you follow a few simple guidelines in regards to:
All submissions should follow, but not strictly adhering to, the Code Guide by @mdo. Also, as a suggestion, you can configure these settings in your editor to follow this coding style.
"translate_tabs_to_spaces": true,
"tab_size": 2,
"ensure_newline_at_eof_on_save": false,
"default_encoding": "UTF-8",
"default_line_ending": "lf",
"trim_trailing_white_space_on_save": true
Names and formatting vary across different editors.
I accept all types of pull requests, just as long as they stay within scope and don't break compatibility downstream. If you're unsure about what impact your request might have, send me a New Feature request first. This gives me a chance to vet it before you start working on something that I may decide not to merge.
Create a pull request by following the instructions below.
- Fork Skim from GitHub:
http://github.com/caleorourke/skim/fork - Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am "add some sweet features" - Push to the branch:
git push origin my-new-feature - Create new Pull Request in GitHub
When submitting a new request, please provide as much context as possible to justify how it fits in with Skim's scope. Click Search to browse current requests or Request to submit a new one.
Got issues? Here are some suggestions to help guide you through escalating it to me.
All issues are bagged and tagged in GitHub. Click Search and make sure your issue hasn't already been reported.
This includes versions, when was it installed, what you're trying to do, and so on.
Help me understand how serious the issue is and what priority I need to triage it in.
Paste any code, logs, or errors into a page on Gist and drop the link to it in the report.
A good report should not require anyone to pine for more information. That's why I suggest using this template. It's sufficient for the majority of reports, albeit some issues may require me to ask for more details.
A summary of the issue and what problem it's causing.
Severity: (e.g. low, medium, high)
Impact: (e.g. minimal, nuisance, show-stopper)
Frequency: (e.g. daily, on shut down, random)
Steps to Reproduce
1. This is the first step
2. This is the second step
3. Additional steps, etc.
[url] (link to your Gist page)
Include any other comments, such as how you worked around it, suggestions you have for fixing it, and so on.
When you're ready, open a new issue and send it over to me.