Contributing

Contributing to Mugshot

Welcome! Thinking about contributing to the development of Mugshot? There's several ways you can help. Pick the one(s) right for you.

Bug Reporting and Triage

The secret to a high quality project? High quality bug reports that make it easier to identify and resolve bugs. Check out the Issues page to find or submit new issues and help Mugshot get fixed faster.

Code

Have a fix or new feature in development? Send me a pull request! I'll review and merge or provide feedback to get everything in order. Let's make Mugshot a better tool for everybody.

Documentation

Notice a typo? Submit an issue and let me know about it! Want to expand the documentation further. Fork the wiki (instructions below), make your changes, and submit an issue with a link to your branch so I can review and merge.

Forking the Wiki and Submitting Your Changes

Adapted from Stack Overflow

1. Manually create a fork of the Mugshot wiki on your GitHub account:

   • Create a new repository on your GitHub account, called "Mugshot-Wiki".

   • Clone the Mugshot Wiki repository to your local machine:

     git clone [email protected]:bluesabre/mugshot.wiki.git

   • Remove the original "origin" remote and add your github repository as new "origin":

     git remote rm origin

     git remote add origin [email protected]:<YOUR_USERNAME>/Mugshot-Wiki.git

2. Make your proposed changes locally, then push them to your GitHub account:

   git push -u origin master

3. Submit an issue to the Mugshot issue tracker so I can review your changes and merge them in. Please be sure to include a link to your repository and describe what you've changed.

Translations

Mugshot translations are managed on Transifex. To contribute, you can submit your translations to Transifex (preferred) or by submitting a pull request on GitHub.

Adapted from GeoNode's Documentation (CC-SA)

Editing Translations Using Transifex

The first workflow for contributing to Mugshot's translations is by using Transifex. The following steps will demonstrate how to update the translations directly on the Transifex website.

1. Create your account.
   • Go to https://www.transifex.com and click Try it for free and enter the needed information to create your free account.
2. Join the Mugshot project.
   • After activating the link you’ve got in your email, you will be asked whether you want to start a new project or to join an existing project.
   • Click join an existing project and type mugshot into the search bar. Select the Mugshot project from the Bluesabre.org organization. You will be directed to the Mugshot project site on Transifex.
   • To join the team, click on the Join team button, then click on the language you want to add a translation in.
3. Wait for permission to update translations from the translation leader. You will receive an email or automatically have the ability to submit translations.
4. Start a translation.
   • Click on the Translate button, then select the language where you want to add a translation.
   • Click untranslated and add your translations.
   • When finished, be sure to click the green save button at the top right of the screen!
5. See your translations in the next release of Mugshot!

Editing Translations Using GitHub

The second workflow for contributing to Mugshot's translations is by translating the files on your local machine and send the translation to the Mugshot official repository in GitHub with pull requests.

Using this option it is assumed that you have a local Mugshot GitHub repository forked.

1. Update (or create from menulibre.pot) your language template in the po/ directory.

2. After you've made your changes, push them to your remote repository using:

   $ git commit

   $ git push

3. Now make a pull request and I will push your changes to Transifex to be included in the official repository.