supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Simplify a great deal the CONTRIBUTING file

Browse Source
This commit is contained in:
Jérémie Astori 2016-02-14 20:03:26 +00:00
parent 2135027040
commit bd73077504
1 changed files with 23 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
CONTRIBUTING.md
View File

@ -5,44 +5,33 @@ your contributions.
### I have a question ### I have a question
Find us on #thelounge channel on Freenode. You might not get an answer right - Find us on the Freenode channel `#thelounge`. You might not get an answer
away, but this channel is filled with nice people who will be happy to help you. right away, but this channel is full of nice people who will be happy to
help you.
### I want to report a bug ### I want to report a bug
First of all, look at the - Look at the [open and closed
[open and closed issues](https://github.com/thelounge/lounge/issues?q=is%3Aissue) issues](https://github.com/thelounge/lounge/issues?q=is%3Aissue) to see if
to see if this was not already discussed before. this was not already discussed before. If you can't see any, feel free to
[open a new issue](https://github.com/thelounge/lounge/issues/new).
### I want to contribute to the code ### I want to contribute to the code
A good starting point if you want to help us but do not have a clear idea of - Make sure to discuss your ideas with the community in an
what you can do specifically is to [issue](https://github.com/thelounge/lounge/issues) or on the IRC channel.
look at the open issues labeled as [*quick and - Take a look at the open issues labeled as [`help wanted`](https://github.com/thelounge/lounge/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22help+wanted%22)
easy*](https://github.com/thelounge/lounge/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22quick+and+easy%22) if you want to help without having a specific idea in mind.
or [*help - Make sure that your PRs do not contain unnecessary commits or merge commits.
wanted*](https://github.com/thelounge/lounge/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22help+wanted%22). [Squash commits](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
whenever possible.
Also, make sure that your PRs do not contain unnecessary commits. If you think - [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) (instead of
some of your commits should be merged into a single one, feel free to [squash merge) outdated PRs on the `master` branch.
them](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History). - Give extra care to your commit messages. Use the [imperative present
tense](https://git-scm.com/book/ch5-2.html#Commit-Guidelines) and [follow Tim
Please [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) outdated Pope's guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
PRs on master to help with the reviews (rebasing is preferred over merging to - Each PR will be reviewed by at least two different project maintainers. You
keep a clean history in a branch/PR). can read more about this in the [maintainers'
Additionally, give extra care to your commit messages, as they will help us
review your PRs as well as help other contributors in the future, when exploring
the history. The general rules are to [use the imperative present
tense](https://git-scm.com/book/ch5-2.html#Commit-Guidelines), to start with a
single concise line, followed by a blank line and a more detailed explanation
when necessary. Tim Pope wrote an [excellent
article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
on how one should format their commit messages.
When you send a PR, expect two different reviews from the project
maintainers. You can read more about this in the [maintainers'
corner](https://github.com/thelounge/lounge/wiki/Maintainers'-corner). corner](https://github.com/thelounge/lounge/wiki/Maintainers'-corner).
- Please document any relevant changes in the documentation that can be found
Please document any relevant changes in the documentation that can be found
[in its own repository](https://github.com/thelounge/thelounge.github.io). [in its own repository](https://github.com/thelounge/thelounge.github.io).