1
0
Fork 0

fix(CONTRIBUTING): v4 updates

This commit is contained in:
Benjamin Fan 2025-05-23 18:49:56 -07:00 committed by Joost De Cock
parent 9d16d1bf76
commit f903929a0a

View file

@ -1,50 +1,51 @@
# Contributing to FreeSewing # Contributing to FreeSewing
First off, First off,
thank you for being part of the freesewing community, thank you for being part of the FreeSewing community,
and for taking the time to contribute! ❤️ and for taking the time to contribute! ❤️
The following is a set of guidelines for contributing to FreeSewing. The following is a set of guidelines for contributing to FreeSewing.
These are mostly guidelines, not rules. These are mostly guidelines, not rules.
Use your best judgment, and feel free to propose changes to this document in a pull request. Use your best judgment, and feel free to propose changes to this document in a pull request.
## Code of Conduct ## Code of Conduct
When you engage with us, or when you engage with others, When you engage with us, or when you engage with others,
please remember [the FreeSewing community standards](https://freesewing.org/docs/about/community-standards/). 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). As a contributor, you are also expected to uphold [the FreeSewing Code of Conduct](https://freesewing.dev/guides/code-of-conduct).
<Tip> :::tip
##### See something, say something ##### See something, say something
Please report unacceptable behavior to [us@freesewing.org](mailto:us@freesewing.org). Please report unacceptable behavior to [us@freesewing.eu](mailto:us@freesewing.eu).
</Tip> :::
## I don't want to read this whole thing I just have a question! ## I don't want to read this whole thing I just have a question!
Please don't file an issue to ask a question. Please don't file an issue to ask a question.
You'll get faster results by contacting us on Discord. You'll get faster results by contacting us on Discord or the Forum.
You can get to our Discord server via https://discord.freesewing.org/. 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. 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. So what's daytime for you might be the middle of the night for others.
Please be patient. Sooner or later, somebody will answer. Please be patient. Sooner or later, somebody will answer.
## What should I know before I get started? ## What should I know before I get started?
Most of FreeSewing's source code lives in [our monorepo](https://github.com/freesewing/freesewing). Most of FreeSewing's source code lives in [our monorepo](https://codeberg.org/freesewing/freesewing).
There are some exceptions: There are some exceptions:
- [`svgtopdf`](https://github.com/freesewing/svgtopdf): The repository holding the source code for our on-demand tiler backend
- [`tile`](https://github.com/freesewing/tile): The repository holding the source code for our command-line tiler - [`tile`](https://github.com/freesewing/tile): The repository holding the source code for our command-line tiler
### FreeSewing packages ### 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://github.com/freesewing/freesewing/tree/develop/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? ## How Can I Contribute?
@ -52,10 +53,7 @@ This file is mostly geared towards code contributors, but there's plenty of othe
### Your first contribution ### Your first contribution
Unsure where to begin contributing to FreeSewing? 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). 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.org/). Don't be afraid to take on an issue. If you get stuck, [we'll help you out](https://discord.freesewing.eu/).
<ReadMore />