59 lines
2.3 KiB
Markdown
59 lines
2.3 KiB
Markdown
# Contributing to FreeSewing
|
|
|
|
First off,
|
|
thank you for being part of the FreeSewing community,
|
|
and for taking the time to contribute! ❤️
|
|
|
|
The following is a set of guidelines for contributing to FreeSewing.
|
|
These are mostly guidelines, not rules.
|
|
Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
|
|
## Code of Conduct
|
|
|
|
When you engage with us, or when you engage with others,
|
|
please remember [the FreeSewing community standards](https://freesewing.eu/docs/about/community-standards/).
|
|
|
|
As a contributor, you are also expected to uphold [the FreeSewing Code of Conduct](https://freesewing.dev/guides/code-of-conduct).
|
|
|
|
:::tip
|
|
|
|
##### See something, say something
|
|
|
|
Please report unacceptable behavior to [us@freesewing.eu](mailto:us@freesewing.eu).
|
|
|
|
:::
|
|
|
|
## I don't want to read this whole thing I just have a question!
|
|
|
|
Please don't file an issue to ask a question.
|
|
You'll get faster results by contacting us on Discord or the Forum.
|
|
You can get to our Discord server via https://discord.freesewing.eu/ .
|
|
You can get to our Forum via https://forum.freesewing.eu/ .
|
|
|
|
Please keep in mind that our community members live all over the world.
|
|
So what's daytime for you might be the middle of the night for others.
|
|
Please be patient. Sooner or later, somebody will answer.
|
|
|
|
## What should I know before I get started?
|
|
|
|
Most of FreeSewing's source code lives in [our monorepo](https://codeberg.org/freesewing/freesewing).
|
|
|
|
There are some exceptions:
|
|
|
|
- [`tile`](https://github.com/freesewing/tile): The repository holding the source code for our command-line tiler
|
|
|
|
### FreeSewing packages
|
|
|
|
We publish a lot of JavaScript packages on NPM. You can find the full list
|
|
[in the `packages` folder of our monorepo](https://codeberg.org/freesewing/freesewing/src/branch/develop/packages).
|
|
|
|
## How Can I Contribute?
|
|
|
|
This file is mostly geared towards code contributors, but there's plenty of other ways you can contribute.
|
|
|
|
### Your first contribution
|
|
|
|
Unsure where to begin contributing to FreeSewing?
|
|
You can start by looking through the issues labeled [good first issue](https://codeberg.org/freesewing/freesewing/issues?q=&type=all&sort=&state=open&labels=344963).
|
|
|
|
Don't be afraid to take on an issue. If you get stuck, [we'll help you out](https://discord.freesewing.eu/).
|