Contributing to SparkleMuffin

SparkleMuffin is in an early stage of development. You may find missing features and incomplete parts.

The project experiments with a Web-based tool for Web bookmarks. The tool saves, tags, and retrieves bookmarks. Its interface stays simple, free of clutter, and responsive on mobile devices.

Read on if this project interests you.

Providing feedback

Issues and improvements

Use the GitHub issue tracker to give feedback about the project and its documentation.

Here are some good ways to start contributing:

• report bugs in the application;
• report missing or outdated documentation;
• suggest improvements to accessibility;
• suggest improvements to the User Interface (UI) and User Experience (UX).

Attach information that helps fix the issue, for example:

• application logs;
• application configuration (redact secrets and other sensitive information first);
• screenshots;
• links to relevant documentation, articles, or previous issues.

Feature requests

Open a new issue on the GitHub issue tracker to discuss improvements to existing features, or to request new features.

Security issues

• TODO: email address for security reports

Submitting patches

Documentation

To contribute to the documentation, set up a local development environment:

• Getting the source code
• Generating the documentation

You can then build the documentation locally, and test your changes before you submit a Pull Request.

Bug Fixes

• TODO: contribution workflow

Improvements and new features

Open a new issue on the GitHub issue tracker to discuss improvements to existing features, or requests for new features, before you submit a patch.

This confirms that:

• the improvement or feature fits the project’s goals;
• the contribution matches the quality of the existing codebase.