Reporting bugs, feature requests: issues management
You can look through existing bugs/requests and help reporting them here.
Constructive input/experience reports/helping other users is welcome.
The general guideline of the fork is to keep Shaarli simple (project and code maintenance, and features-wise), while providing customization capabilities (plugin system, making more settings configurable).
Check the milestones to see what issues have priority.
The official documentation is generated from Markdown documents in the
doc/md/ directory. HTML documentation is generated using Mkdocs. Read the Docs provides hosting for the online documentation.
To edit the documentation, please edit the appropriate
doc/md/*.md files (and optionally
make htmlpages to preview changes to HTML files). Then submit your changes as a Pull Request. Have a look at the MkDocs documentation and configuration file
mkdocs.yml if you need to add/remove/rename/reorder pages.
Currently Shaarli has no translation/internationalization/localization system available and is single-language. You can help by proposing an i18n system (issue https://github.com/shaarli/Shaarli/issues/121)
You can help testing Shaarli releases by immediately upgrading your installation after a new version has been releases.
All current development happens in Pull Requests. You can test proposed patches by cloning the Shaarli repo, adding the Pull Request branch and
git checkout to it. You can also merge multiple Pull Requests to a testing branch.
git clone https://github.com/shaarli/Shaarli git remote add pull-request-25 owner/cool-new-feature git remote add pull-request-26 anotherowner/bugfix git remote update git checkout -b testing git merge cool-new-feature git merge bugfix
Or see Checkout Github Pull Requests locally
Please report any problem you might find.
git cloneyour fork
master, switch to a new branch (eg.
git checkout -b my-awesome-feature)
Cool new feature, fixes issue #1001)
All changes you will do on the
my-awesome-feature in the future will be added to your Pull Request. Don't work directly on the master branch, don't do unrelated work on your
If you are not familiar with Git or Github, here are a few links to set you on track: