PrivateCoffee/quackscape
PrivateCoffee/quackscape
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
quackscape/CONTRIBUTING.md
Kumi 743f97a6ab
feat: introduce Code of Conduct and Contributing Guidelines 
Added a comprehensive Code of Conduct and Contributing Guidelines for
the Quackscape project to foster a positive community environment and
streamline the contribution process. The Code of Conduct pledges an
inclusive, harassment-free experience for all contributors, while the
Contributing Guidelines outline steps for asking questions, reporting
bugs, suggesting enhancements, and making first code contributions.
These additions aim to enhance participation clarity, ensure respectful
interactions, and encourage contributions by outlining expectations and
procedures, thus promoting a healthier, more collaborative development
atmosphere.
2024-03-15 09:33:56 +01:00

137 lines
11 KiB
Markdown
Raw Blame History

<!-- omit in toc -->
# Contributing to Quackscape
First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues/followers...
<!-- omit in toc -->
## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Improving The Documentation](#improving-the-documentation)
- [Styleguides](#styleguides)
- [Commit Messages](#commit-messages)
- [Join The Project Team](#join-the-project-team)
## Code of Conduct
This project and everyone participating in it is governed by the
[Quackscape Code of Conduct](https://git.private.coffee/PrivateCoffee/quackscapeblob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <support@private.coffee> or any of the maintainers in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee).
## I Have a Question
Before you ask a question, it is best to search for existing [Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. Our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee) is also a good place to ask for help.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue in the [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues/new) (or on [GitHub](https://github.com/PrivateCoffee/quackscape/issues/new) if you cannot use Private.coffee Git).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
We will then take care of the issue as soon as possible.
## I Want To Contribute
> ### Legal Notice <!-- omit in toc -->
>
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. You understand that your content becomes an inseparable part of the project, and grant Private.coffee unrestricted and irrevocable rights to use and redistribute your content.
### Reporting Bugs
<!-- omit in toc -->
#### Before Submitting a Bug Report
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check [this section](#i-have-a-question).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://git.private.coffee/PrivateCoffee/quackscapeissues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the Git community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
<!-- omit in toc -->
#### How Do I Submit a Good Bug Report?
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@private.coffee> (you can find our GPG public key at [security.private.coffee](https://security.private.coffee)) or to any of the maintainers via Matrix (simply ask in [#quackscape:private.coffee](https://matrix.private.cf/#/#quackscape:private.coffee)).
We use Private.coffee Git issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue on [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues/new) (or [GitHub](https://github.com/PrivateCoffee/quackscape/issues/new) if you cannot use Private.coffee Git). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
### Suggesting Enhancements
This section guides you through submitting an enhancement suggestion for Quackscape, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
<!-- omit in toc -->
#### Before Submitting an Enhancement
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://git.private.coffee/PrivateCoffee/quackscape/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
<!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion?
Enhancement suggestions are tracked as issues in [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues). You can also open issues on [GitHub](https://github.com/PrivateCoffee/quackscape/issues) if you don't want to use Private.coffee Git.
- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
- **Explain why this enhancement would be useful** to most Quackscape users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
### Your First Code Contribution
Unsure where to begin contributing to Quackscape? You can start by looking through these `good-first-issue` and `help-wanted` issues:
- [Good First Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- [Help Wanted Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
Both of these tags are a great starting point for new contributors. They are easy to fix and are a great way to get started with the codebase.
If you decide to work on an issue, please leave a comment so that other people know that the issue is being addressed. If you are a first-time contributor, please read the [Code of Conduct](https://git.private.coffee/PrivateCoffee/quackscapeblob/master/CODE_OF_CONDUCT.md), too.
If at all possible, please use our [Private.coffee Git repository](https://git.private.coffee/PrivateCoffee/quackscape/) for your contributions, as our GitHub is only a mirror of this.
If you have questions or need help, please ask in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee).
### Improving The Documentation
Quackscape could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
## Join The Project Team
If you are interested in joining the project team, please reach out to the maintainers in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee) and let us know how you would like to help out. We are always looking for more help and would love to have you on board!
## Attribution
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
Reference in a new issue View git blame Copy permalink