Contributing

Contributors' guide

First of all, thank you for taking the time to read this document and contribute to this project by adding new features, enhancing it, helping me to find bugs and discussing about it. I am trying to make this project stable and usable by everyone by making it simple and easy, adding more features, enhancing the project and writing clear documentation.

The following is a set of guidelines for contributing to my project.

How do I contribute?

"I don't want or need to read all of this! I just have a question!"

You may create an issue to make it visible and clear for everybody else having the same question.

You may not use Discord PMs or Mail to get in touch, as it would hide your concern from everybody else.

• All meta issues shall be closed without further replies or comments.

• Other users may help you on my behalf. Be patient and respect them. Thank you if you take the time to help other users!

• All requests outside of Codeberg shall be ignored.

Reporting bugs

Before filing a bug report, make sure to read the following list:

• Search for your issue to avoid duplicates. To make issues easier to find, I may as well rename them.

• Report problems related to quick.db here.

My only bug/feature/enhancement tracker is at Codeberg Issues and Pull Requests. This means no Discord or emails.

Issues Guidelines

Here are some guidelines to help you create your issue and help me reproduce and fix the problem:

• Use a clear and descriptive title. Accordingly to the content and comments of your issue, I may edit the title to make it easier to look for.

• Describe the steps. Provide as many details as possible to reproduce the bug.

• Provide screenshots or a stacktrace. When copy-pasting your error from your console, make sure to copy the entire stacktrace and to include the line where it happened. Add a screenshot by importing it to Codeberg.

Suggesting enhancements

Before doing so,

• Search for your issue to avoid duplicates.

• Make sure that your enhancement has not yet been added to the project.

Using Issues

Read the Issues Guidelines, but instead of providing a stacktrace:

• Describe the current and expected behaviors.

• Explain how this would be useful.

Using Forks & Pull Requests

The GitHub repository may soon be archived, if not yet. Do not make pull requests there.

• Maintain your PR up-to-date with recent commits.

• Use present tense and imperative mood in your commit title.

• Reference related issues and other PRs in the commit description.

• Maintain the indentation. You may also use a linter before submitting your PR.

Additional notes

Documentation

Use Issues.

Labels

All labels are self-explanatory.