diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index daf8fad3..762cbf79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,31 @@ ## Submitting an issue + Bug reports and feature requests can be submitted to our [Issue Tracker](https://github.com/autodl-community/autodl-trackers/issues). -Please give as many details as possible and use an appropriate, descriptive title. -If you need to keep some info private, you can e-mail that info to autodl.community@gmail.com with the subject ``Issue #`` replacing \# with the number of the your issue. +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 autodl.community@gmail.com with the subject ``Issue #`` replacing \# with the number of your issue. ## Submitting code -If you [fork us](https://help.github.com/articles/fork-a-repo), please make all changes to the [devel branch](https://github.com/autodl-community/autodl-trackers/tree/devel). -Keep your code consistent with the rest of the project (indentation, etc). -[Pull Requests](https://help.github.com/articles/creating-a-pull-request) will only be accepted if made against [devel](https://github.com/autodl-community/autodl-trackers/tree/devel). -Patches are welcome. Diffs are preferable and strongly advised if you change multiple files. For simple, single file changes, sending your modified file is acceptable. +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](https://help.github.com/articles/using-pull-requests/) feature is preferable. + +### Pull Requests + +You should make a separate [feature branch][fb] in your [fork][fork] to make commit your changes to. [Pull Requests][https://help.github.com/articles/creating-a-pull-request] will only be accepted if made from a [feature branch][fb] and against the [devel](https://github.com/autodl-community/autodl-trackers/tree/devel) branch of this repository. + +Commit messages should be written in a [well-formed, consistent](https://sethrobertson.github.io/GitBestPractices/#usemsg) manner. See the [commit log](https://github.com/autodl-community/autodl-trackers/commits/devel) 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](https://www.atlassian.com/git/tutorials/rewriting-history/git-commit--amend) or [rebase](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase-i) to change your previous commit(s) then [force push](http://stackoverflow.com/a/12610763) to the [feature branch][fb] in your [fork][fork]. + +[fb]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#creating-a-branch +[fork]: https://help.github.com/articles/fork-a-repo ## Misc For anything else, contact us by e-mail at autodl.community@gmail.com or on IRC in ``#autodl-community`` on ``irc.p2p-network.net`` \ No newline at end of file