If you happen to test PiNanas on architectures or OSes not listed in INSTALL, please report your findings. You can either do a Pull Request to update PiNanas' documentation, or open an issue as if it was a "bug" of documentation. See Report issues.
Please report issues and bug, suggest new features, share success when testing new hardware or OSes, by opening an Issue on PiNanas Github repository.
To contribute to project, you will need to install on your computer Git and to have a Github account.
If you don't really know how to use git, I will recommend you to check this guide. If you are comfortable with git and GitHub, just go to "Create a pull request" section.
Associate your GitHub account and your local git configuration:
- Set up your name:
git config --global user.name "Firstname lastname" - Set up your e-mail address:
git config --global user.email "email@example.com"
You have to click on the fork button of the PiNanas GitHub.
Go where you want to work on the project (for example in your home directory) and enter this command (don't forget to
replace username with your GitHub username):
git clone https://github.com/username/pinanas
To avoid conflicts when updating your fork from the upstream, always work on a branch (from develop):
git checkout develop
git checkout -b feature/42-make-coffee
We recommend explicit name for your branch, such as feature/<id>-<short-description>.
Now, you can work on your new branch. Modify code, test your changes and commit locally.
Update your GitHub repository:
git push origin feature/42-make-coffee
On GitHub you should see your freshly-pushed branch (with commits):
Click the "Compare & pull request" button, you will be prompted for a name for your pull request (PR).
Example name of a pull request: Issue 42: make coffee
If you forget something, don't worry: you can continue to push commits on your branch and it will automatically update your pull request.
Now the PiNanas team can review your pull request... and merge it! If need be, do @ping the team.
Thank you for your time, interest and effort :)
If you had to update your fork because there is activity on the upstream, you can go to this link: syncing a fork.
When you finished your work and about to commit the final change, you can specify Fixes and the GitHub id of the original issue to help the Piwigo team. This will close automatically the pull request when this will be merged on the upstream.
Example of a last commit: Fixes #42 Make coffee.