2015-09-26 15:41:16 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2016-02-10 05:01:50 +00:00
|
|
|
Welcome to The Lounge, it's great to have you here! We thank you in advance for
|
|
|
|
|
your contributions.
|
2015-09-26 15:41:42 +00:00
|
|
|
|
2015-10-07 03:14:20 +00:00
|
|
|
### I want to report a bug
|
|
|
|
|
|
2016-02-14 20:03:26 +00:00
|
|
|
- Look at the [open and closed
|
2018-02-21 17:48:22 +00:00
|
|
|
issues](https://github.com/thelounge/thelounge/issues?q=is%3Aissue) to see if
|
2016-02-14 20:03:26 +00:00
|
|
|
this was not already discussed before. If you can't see any, feel free to
|
2018-02-21 17:48:22 +00:00
|
|
|
[open a new issue](https://github.com/thelounge/thelounge/issues/new).
|
2018-01-15 01:54:22 +00:00
|
|
|
- If you think you discovered a security vulnerability, **do not open a public
|
2018-06-29 16:32:52 +00:00
|
|
|
issue on GitHub.** Refer to our [security guidelines](/SECURITY.md) instead.
|
2015-10-07 03:14:20 +00:00
|
|
|
|
|
|
|
|
### I want to contribute to the code
|
|
|
|
|
|
2016-02-14 20:03:26 +00:00
|
|
|
- Make sure to discuss your ideas with the community in an
|
2018-02-21 17:48:22 +00:00
|
|
|
[issue](https://github.com/thelounge/thelounge/issues) or on the IRC channel.
|
2018-02-23 13:40:36 +00:00
|
|
|
- Take a look at the open issues labeled as [`help wanted`](https://github.com/thelounge/thelounge/labels/help%20wanted)
|
2016-02-14 20:03:26 +00:00
|
|
|
if you want to help without having a specific idea in mind.
|
|
|
|
|
- Make sure that your PRs do not contain unnecessary commits or merge commits.
|
|
|
|
|
[Squash commits](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
|
|
|
|
|
whenever possible.
|
|
|
|
|
- [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) (instead of
|
|
|
|
|
merge) outdated PRs on the `master` branch.
|
|
|
|
|
- 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
|
|
|
|
|
Pope's guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
|
- Each PR will be reviewed by at least two different project maintainers. You
|
|
|
|
|
can read more about this in the [maintainers'
|
2019-07-17 07:45:34 +00:00
|
|
|
corner](https://github.com/thelounge/thelounge/wiki/Maintainers'-corner).
|
2016-02-14 20:03:26 +00:00
|
|
|
- Please document any relevant changes in the documentation that can be found
|
2018-01-14 07:15:08 +00:00
|
|
|
[in its own repository](https://github.com/thelounge/thelounge.chat).
|
2019-07-19 10:30:43 +00:00
|
|
|
- Note that we use prettier on the project. You can set up IDE plugins to format
|
|
|
|
|
on save ([see VS Code one here](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)).
|
|
|
|
|
- We have a git hook to automatically run prettier before commit, in case you don't install the plugin.
|
|
|
|
|
- If for any reason, prettier does not work for you, you can run `yarn format:prettier` and that should format everything.
|
