1
0
Fork 0
freesewing/CONTRIBUTING.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2020-10-24 19:22:49 +02:00
# Contributing to FreeSewing
2025-05-23 18:49:56 -07:00
First off,
thank you for being part of the FreeSewing community,
and for taking the time to contribute! ❤️
2020-10-24 19:22:49 +02:00
The following is a set of guidelines for contributing to FreeSewing.
2025-05-23 18:49:56 -07:00
These are mostly guidelines, not rules.
2020-10-24 19:22:49 +02:00
Use your best judgment, and feel free to propose changes to this document in a pull request.
## Code of Conduct
2025-05-23 18:49:56 -07:00
When you engage with us, or when you engage with others,
please remember [the FreeSewing community standards](https://freesewing.eu/docs/about/community-standards/).
2020-10-24 19:22:49 +02:00
2025-05-23 18:49:56 -07:00
As a contributor, you are also expected to uphold [the FreeSewing Code of Conduct](https://freesewing.dev/guides/code-of-conduct).
2020-10-24 19:22:49 +02:00
2025-05-23 18:49:56 -07:00
:::tip
2020-10-24 19:22:49 +02:00
##### See something, say something
2025-05-23 18:49:56 -07:00
Please report unacceptable behavior to [us@freesewing.eu](mailto:us@freesewing.eu).
2020-10-24 19:22:49 +02:00
2025-05-23 18:49:56 -07:00
:::
2020-10-24 19:22:49 +02:00
## I don't want to read this whole thing I just have a question!
2025-05-23 18:49:56 -07:00
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/ .
2020-10-24 19:22:49 +02:00
2025-05-23 18:49:56 -07:00
Please keep in mind that our community members live all over the world.
2020-10-24 19:22:49 +02:00
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?
2025-05-23 18:49:56 -07:00
Most of FreeSewing's source code lives in [our monorepo](https://codeberg.org/freesewing/freesewing).
2020-10-24 19:22:49 +02:00
2022-06-06 18:18:20 +02:00
There are some exceptions:
2020-10-24 19:22:49 +02:00
- [`tile`](https://github.com/freesewing/tile): The repository holding the source code for our command-line tiler
### FreeSewing packages
2025-05-23 18:49:56 -07:00
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).
2020-10-24 19:22:49 +02:00
## How Can I Contribute?
2022-06-06 18:18:20 +02:00
This file is mostly geared towards code contributors, but there's plenty of other ways you can contribute.
2020-10-24 19:22:49 +02:00
### Your first contribution
2025-05-23 18:49:56 -07:00
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).
2020-10-24 19:22:49 +02:00
2025-05-23 18:49:56 -07:00
Don't be afraid to take on an issue. If you get stuck, [we'll help you out](https://discord.freesewing.eu/).