-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
11957fe
commit a00bb35
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
edit_documentation_here/source/contributor_guide/contributor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contributor Guide | ||
<br/> | ||
|
||
There are several ways to contribute to InVesalius, but we highlight two: contributing with source code and/or translating the software into other languages. | ||
|
||
## Contributing to code | ||
|
||
1. Fork [InVesalius](https://github.com/invesalius/invesalius3) at GitHub (https://help.github.com/articles/fork-a-repo). | ||
|
||
2. Create a branch for the desired feature you are going to develop, since we work with branches. | ||
|
||
3. Pull Request (https://help.github.com/articles/using-pull-requests). | ||
|
||
Please, write source code comments and commit messages in English. And follow the [PEP 8 coding style](http://www.python.org/dev/peps/pep-0008/). | ||
|
||
See in [this link the instructions](https://invesalius.github.io/docs/installation_guide/installation_guide.html) to install InVesalius and its dependencies. | ||
|
||
## Contributing to translation | ||
|
||
InVesalius is under constant development, which makes it a challenge for translation into multiple languages. | ||
|
||
You can help us both: improving existing translations, or translating InVesalius to new languages. We are currently using [Transifex](https://www.transifex.com/), an open web service that help the translator's job. | ||
|
||
Using Transifex to translate InVesalius | ||
|
||
1. Register for a [Transifex account](https://www.transifex.com/signup). | ||
2. See your e-mail inbox and validate your account. | ||
3. Access [InVesalius translation website](https://www.transifex.com/projects/p/invesalius3/). | ||
4. **Request language** if the language you will translate is not on the available translations. Or Select one of available translations, click the link **gui - po/en.po** then click the button **Translate now**. | ||
5. Wait for the translation permission. | ||
6. Do not forget to press save while you translate – and after you have finished. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters