mirror of
https://github.com/HandBrake/HandBrake-docs.git
synced 2025-12-11 04:35:53 -06:00
docs: Add Contributing article.
This commit is contained in:
Bradley Sepos
parent
c0ba24dc36
commit
4603369ec8
65
source/docs/en/1.1.0/contributing/contribute.markdown
Normal file
65
source/docs/en/1.1.0/contributing/contribute.markdown
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
Type: article
|
||||
Title: Contributing
|
||||
Project: HandBrake
|
||||
Project_URL: https://handbrake.fr/
|
||||
Project_Version: Latest
|
||||
Language: English
|
||||
Language_Code: en
|
||||
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
|
||||
Copyright: 2018 HandBrake Team
|
||||
License: Creative Commons Attribution-ShareAlike 4.0 International
|
||||
License_Abbr: CC BY-SA 4.0
|
||||
License_URL: https://handbrake.fr/docs/license.html
|
||||
---
|
||||
|
||||
Contributing
|
||||
============
|
||||
|
||||
HandBrake is an open source project created and maintained by the HandBrake Team. All are welcome to contribute to the project, and contributions following these simple guidelines are more likely to be accepted.
|
||||
|
||||
## Conduct
|
||||
|
||||
First and foremost, familiarize yourself with the project's [Code of Conduct](https://github.com/HandBrake/HandBrake/blob/master/CODE_OF_CONDUCT.md) and [Community Forum Rules](https://forum.handbrake.fr/app.php/rules). The HandBrake Team expects all contributors to conduct themselves accordingly.
|
||||
|
||||
## Communication
|
||||
|
||||
Please ask the HandBrake Team via one of the [Community Support](../help/community-support.html) channels before adding major features or making other sweeping changes.
|
||||
|
||||
*Failure to communicate what you are working on may lead to duplicated efforts or rejection of your contributions.*
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
### User interface and graphics
|
||||
|
||||
HandBrake's user interface is constantly evolving. Special care and expertise are required to enhance usability while retaining and expanding its many professional features. Icons and other graphic assets are also needed from time to time, as user interface updates and modernization dictate.
|
||||
|
||||
The HandBrake Team welcomes contributions from user interface and graphic designers. Please introduce yourself via one of the [Community Support](../help/community-support.html) channels and someone will be glad to share what others are currently working on, and discuss your interests and how you can help.
|
||||
|
||||
### Code
|
||||
|
||||
Developers wanting to contribute code should check out the [HandBrake source code on GitHub](https://github.com/HandBrake/HandBrake) and a create pull request on GitHub for each contribution.
|
||||
|
||||
[Open issues](https://github.com/HandBrake/HandBrake/issues) are good candidates for learning and fixing various parts of the code base.
|
||||
|
||||
### Documentation
|
||||
|
||||
[HandBrake Documentation](https://handbrake.fr/docs/) is published on the official HandBrake website, and the [documentation source](https://github.com/HandBrake/HandBrake-docs) is hosted on GitHub.
|
||||
|
||||
Please read the documentation project's [Contributing](https://github.com/HandBrake/HandBrake-docs/blob/master/CONTRIBUTING.markdown) guide to get started.
|
||||
|
||||
### Translation
|
||||
|
||||
HandBrake is written and maintained in English, and translated into multiple international languages by a community of volunteers.
|
||||
|
||||
The following projects host translations of the user interface strings used by the HandBrake application:
|
||||
|
||||
- HandBrake for Linux on Transifex
|
||||
- [HandBrake 1.1.1](https://www.transifex.com/victorr2007/handbrake-111/)
|
||||
- [HandBrake 1.1.0](https://www.transifex.com/victorr2007/handbrake-110/)
|
||||
- HandBrake for Mac on Transifex
|
||||
- [HandBrake 1.1.x](https://www.transifex.com/subler/handbrake-1/)
|
||||
|
||||
The HandBrake Team is working on bringing full technical support for multiple languages to all supported platforms; in the meantime, you will likely find translations available for some platforms and not others.
|
||||
|
||||
If you would like to contribute a translation of the HandBrake Documentation, please base it on the English documentation and submit a pull request to the documentation project on GitHub.
|
||||
@ -105,11 +105,11 @@ Table of contents
|
||||
*Activity Logs help you receive better support*
|
||||
|
||||
|
||||
## HandBrake lore
|
||||
## More information
|
||||
|
||||
- [Project history](about/history.html)
|
||||
|
||||
<!-- - [About the cocktail and pineapple icon](about/the-icon.html) -->
|
||||
- [Contributing](contributing/contribute.html)
|
||||
*How you can get involved*
|
||||
|
||||
|
||||
## CLI documentation
|
||||
@ -166,5 +166,3 @@ Table of contents
|
||||
- Packaging HandBrake
|
||||
- [Flatpak apps for Linux](developer/flatpak-repo.html)
|
||||
*Fully-contained applications compatible with multiple Linux distributions*
|
||||
|
||||
<!-- TODO: link to contributing guide -->
|
||||
|
||||
65
source/docs/en/latest/contributing/contribute.markdown
Normal file
65
source/docs/en/latest/contributing/contribute.markdown
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
Type: article
|
||||
Title: Contributing
|
||||
Project: HandBrake
|
||||
Project_URL: https://handbrake.fr/
|
||||
Project_Version: Latest
|
||||
Language: English
|
||||
Language_Code: en
|
||||
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
|
||||
Copyright: 2018 HandBrake Team
|
||||
License: Creative Commons Attribution-ShareAlike 4.0 International
|
||||
License_Abbr: CC BY-SA 4.0
|
||||
License_URL: https://handbrake.fr/docs/license.html
|
||||
---
|
||||
|
||||
Contributing
|
||||
============
|
||||
|
||||
HandBrake is an open source project created and maintained by the HandBrake Team. All are welcome to contribute to the project, and contributions following these simple guidelines are more likely to be accepted.
|
||||
|
||||
## Conduct
|
||||
|
||||
First and foremost, familiarize yourself with the project's [Code of Conduct](https://github.com/HandBrake/HandBrake/blob/master/CODE_OF_CONDUCT.md) and [Community Forum Rules](https://forum.handbrake.fr/app.php/rules). The HandBrake Team expects all contributors to conduct themselves accordingly.
|
||||
|
||||
## Communication
|
||||
|
||||
Please ask the HandBrake Team via one of the [Community Support](../help/community-support.html) channels before adding major features or making other sweeping changes.
|
||||
|
||||
*Failure to communicate what you are working on may lead to duplicated efforts or rejection of your contributions.*
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
### User interface and graphics
|
||||
|
||||
HandBrake's user interface is constantly evolving. Special care and expertise are required to enhance usability while retaining and expanding its many professional features. Icons and other graphic assets are also needed from time to time, as user interface updates and modernization dictate.
|
||||
|
||||
The HandBrake Team welcomes contributions from user interface and graphic designers. Please introduce yourself via one of the [Community Support](../help/community-support.html) channels and someone will be glad to share what others are currently working on, and discuss your interests and how you can help.
|
||||
|
||||
### Code
|
||||
|
||||
Developers wanting to contribute code should check out the [HandBrake source code on GitHub](https://github.com/HandBrake/HandBrake) and a create pull request on GitHub for each contribution.
|
||||
|
||||
[Open issues](https://github.com/HandBrake/HandBrake/issues) are good candidates for learning and fixing various parts of the code base.
|
||||
|
||||
### Documentation
|
||||
|
||||
[HandBrake Documentation](https://handbrake.fr/docs/) is published on the official HandBrake website, and the [documentation source](https://github.com/HandBrake/HandBrake-docs) is hosted on GitHub.
|
||||
|
||||
Please read the documentation project's [Contributing](https://github.com/HandBrake/HandBrake-docs/blob/master/CONTRIBUTING.markdown) guide to get started.
|
||||
|
||||
### Translation
|
||||
|
||||
HandBrake is written and maintained in English, and translated into multiple international languages by a community of volunteers.
|
||||
|
||||
The following projects host translations of the user interface strings used by the HandBrake application:
|
||||
|
||||
- HandBrake for Linux on Transifex
|
||||
- [HandBrake 1.1.1](https://www.transifex.com/victorr2007/handbrake-111/)
|
||||
- [HandBrake 1.1.0](https://www.transifex.com/victorr2007/handbrake-110/)
|
||||
- HandBrake for Mac on Transifex
|
||||
- [HandBrake 1.1.x](https://www.transifex.com/subler/handbrake-1/)
|
||||
|
||||
The HandBrake Team is working on bringing full technical support for multiple languages to all supported platforms; in the meantime, you will likely find translations available for some platforms and not others.
|
||||
|
||||
If you would like to contribute a translation of the HandBrake Documentation, please base it on the English documentation and submit a pull request to the documentation project on GitHub.
|
||||
@ -105,11 +105,11 @@ Table of contents
|
||||
*Activity Logs help you receive better support*
|
||||
|
||||
|
||||
## HandBrake lore
|
||||
## More information
|
||||
|
||||
- [Project history](about/history.html)<span class="notice draft"><span>draft</span></span>
|
||||
|
||||
<!-- - [About the cocktail and pineapple icon](about/the-icon.html) -->
|
||||
- [Contributing](contributing/contribute.html)
|
||||
*How you can get involved*
|
||||
|
||||
|
||||
## CLI documentation
|
||||
@ -166,5 +166,3 @@ Table of contents
|
||||
- Packaging HandBrake
|
||||
- [Flatpak apps for Linux](developer/flatpak-repo.html)<span class="notice draft"><span>draft</span></span>
|
||||
*Fully-contained applications compatible with multiple Linux distributions*
|
||||
|
||||
<!-- TODO: link to contributing guide -->
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user