Skip to content

Commit c4ce95a

Browse files
chewittFlole998
authored andcommitted
repo: cleanup CONTRIBUTING.md
Signed-off-by: Christian Hewitt <christianshewitt@gmail.com>
1 parent 91d1075 commit c4ce95a

1 file changed

Lines changed: 26 additions & 22 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,39 @@
1-
# How to Contribute
1+
# Contributing
22

3-
The Tvheadend project welcomes all submissions from the community. Without them the project couldn't hope to thrive.
3+
Tvheadend welcomes all code contributions. To ensure the process of contributing runs smoothly please follow the guidelines below:
44

5-
We want to ensure that the process of submitting code is as simple as possible whilst ensuring that the project has the necessary provisions to fully utilize and handle all submissions. Therefore some short guidelines are provided here for reference.
5+
## Preparation
66

7-
## Before you start
7+
* Create a [GitHub account](https://github.com/signup/free)
8+
* Fork the project repository on Github
9+
* Discuss feature ideas with staff and users via the [Forum](https://tvheadend.org/feature-ideas) or [GitHub](https://github.com/tvheadend/tvheadend/issues)
810

9-
* Make sure you have a [GitHub account](https://github.com/signup/free)
10-
* Log on to the [Forum](https://tvheadend.org), this is the best place to discussion development work.
11-
* Fork the repository on Github
11+
## Make Changes
1212

13-
## Making Changes
13+
* Create a topic branch for your changes with a simple name, e.g. `new-feature-name` or `fix-issue-1234`
14+
* Create one topic branch per feature or bugfix
15+
* Make changes and commit them, keep the scope of each commit simple (commits can be squashed later)
16+
* Commit message subject lines should use a `subsystem: description of change` format
17+
* Provide additional info in the commit message body if required (detail is always good)
18+
* GUI help changes must be made in the master `en_GB` template
1419

15-
* If unsure, discuss any potential work on IRC channel to avoid duplicate work.
16-
* Create a branch to put your changes. Use a sensible name, i.e. feature/whizzbanger, or bugfix/issue-1234. It is strongly recommend you create one branch per feature/bugfix/etc.
17-
* Make commits, try and keep commits to sensible units.
18-
* Use sensible commit messages, prefix with subsystem, summary on first line, more detail on following lines and include reference to any related issue numbers in Github or forum threads.
20+
## Submit Changes
1921

20-
````
21-
mpegts dvb: Add foo feature to the DVB system.
22+
* Create a pull request to our `master` development branch
23+
* Create a `Draft` pull request if your changes are still work in progress
24+
* Pull request titles should use a `subsystem: description of change` format
25+
* Use repo labels to classify the pull request
26+
* Link related forum discussion threads for information
27+
* Link GitHub issues using the `Fixes: #1234` format so tickets auto-close on merge
2228

23-
Some more detail description of what has been done.
29+
## Documentation
2430

25-
This fixes #1234.
26-
````
27-
* Submit a Pull Request on Github.
31+
If your changes require documentation updates please use GitBooks to author changes and submit a merge-request. The registration link is on our public documenation site: [https://docs.tvheadend.org](https://docs.tvheadend.org).
2832

29-
# Additional Resources
33+
## Resources
3034

3135
* [Forum](https://tvheadend.org)
32-
* [General GitHub documentation](http://help.github.com/)
33-
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
34-
* #hts IRC channel on libera.chat
36+
* [#hts IRC Channel on Libera.Chat](https://web.libera.chat/#hts)
37+
* [GitHub General Documentation](http://help.github.com/)
38+
* [GitHub Pull Request Documentation](http://help.github.com/send-pull-requests/)
3539

0 commit comments

Comments
 (0)