Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 2.54 KB

Requesting a new tracker

Submit an issue to the Issue Tracker or come to the IRC channel below with the following information:

  • Tracker name
  • Tracker abbreviation (if applicable)
  • Tracker IRC server address
  • Tracker IRC announce channel
  • Tracker IRC announcer name
  • A decent size sampling of announces from the announce channel (at least 5-10)

Preferably, this information should be provided using a pastebin site. More information may be requested if necessary.

Submitting an issue

Bug reports and feature requests can be submitted to our Issue Tracker.

Some general guidelines to follow:

  • Use an appropriate, descriptive title.
  • Provide as many details as possible.
  • Don't piggy-back. Keep separate topics in separate issues.

If you need to keep some information private, you can e-mail [email protected] with the subject Issue # replacing # with the number of your issue.

Submitting code

Patches are welcome. Keep your code consistent with the rest of the project (use tabs for indentation, etc). If you have any questions or concerns, contact us through the methods listed below.

For simple, single file changes/additions, sending or linking your modified file is acceptable. For complex, multiple file changes, creating a diff file or using GitHub's Pull Request feature is preferable.

Pull Requests

Pull Requests should originate from a feature branch in your fork, not from the master branch.

Commit messages should be written in a well-formed, consistent manner. See the commit log for acceptable examples.

Each commit should encompass the smallest logical changeset (e.g. changing two unrelated things in the same file would be two commits rather than one commit of "Change filename".) If you made a mistake in a commit in your Pull Request, you should amend or rebase to change your previous commit(s) then force push to the feature branch in your fork.