Thank you for getting interested in contribution to this project! We really appreciate it. 😊
- Submit Bug Reports or Feature Requests
- Translate the Project
- Propose Code Changes
- Manage the Project
- Search for existing issues to check if it's a known issue.
- If it's not reported yet, create a new issue.
Tip
If you are not used to do, this section is for you.
We accept translations through Weblate:
- reco-app: Texts in the app itself
- reco-metainfo: Texts in the desktop entry and the software center
Alternatively, you can fork this repository, edit the *.po
files directly, and submit changes through pull requests.
Note
Strings in the translation files are updated automatically if they're changed in the source code.
Things to happen when strings are changed in the source code:
- GitHub Actions (gettext-flatpak) updates the
*.pot
file and commits it to the repository - Weblate Addon (Update PO files to match POT (msgmerge)) detects the modification of
*.pot
file, updates*.po
files accordingly, and commits them to the repository
We accept changes to the source code through pull requests―even a small typo fix is welcome.
Tip
Again, the guideline by elementary would be helpful here too.
We follow the coding style of elementary OS and its Human Interface Guidelines. Try to respect them.
- Repository URL: https://github.com/ryonakano/reco
- Decide the version number of the release
- Versioning should follow Semantic Versioning
- Create a new branch named
release-X.Y.Z
from the latestorigin/main
(X.Y.Z
is the version number) - See changes since the previous release:
git diff $(git describe --tags --abbrev=0)..release-X.Y.Z
- Perform changes
- Write a release note in
data/reco.metainfo.xml.in
- Refer to the Metainfo guidelines by Flathub
- Credits contributors with their GitHub username
- Translation contributors are excluded because some don't have a GitHub account. Just writing
Update translations
is fine
- Translation contributors are excluded because some don't have a GitHub account. Just writing
- Bump
version
inmeson.build
- Update screenshots if there are visual changes between releases
- Write a release note in
- Create a pull request with the above changes
- Merge it once the build succeeded
- Create a new release on GitHub
- Create a new tag named
X.Y.Z
- Release title:
<Project Name> X.Y.Z Released
- It's fine to reuse the release note in the metainfo file as the release description. Just convert XML to Markdown
- Publish it when completed
- Create a new tag named
- Repository URL: https://github.com/elementary/appcenter-reviews
- Fork the repository if you don't have write access to it
- Create a new branch named
com.github.ryonakano.reco-X.Y.Z
- Perform changes
- Change
commit
andversion
in theapplications/com.github.ryonakano.reco.json
commit
should be the release commit just we published on the project repositoryversion
for the relase version
- Change
- Create a pull request with the above changes
- Await for review approval and merge
- The new release should be available on AppCenter after some time
- Repository URL: https://github.com/flathub/com.github.ryonakano.reco
- Create a new branch named
release-X.Y.Z
- Perform changes
- Change
url
andsha256
in the manifest file- These two parameters should point to the tar.gz of the release assets just we published on the project repository
- Change
- Create a pull request with the above changes
- Merge it once the build succeeded
- The new release should be available on Flathub after some time