Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

63 lines (37 loc) · 2.46 KB

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.

As a contributor, you are also expected to uphold the FreeSewing Code of Conduct.

See something, say something

Please report unacceptable behavior to [email protected].

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. You can get to our Discord server via https://discord.freesewing.org/.

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.

There are some exceptions:

  • svgtopdf: The repository holding the source code for our on-demand tiler backend
  • 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.

How Can I Contribute?

This file is mostly geared towards code contributors, but there's plenty of other ways you can contribute.

As it happens, we keep a list of suggestions at: https://freesewing.dev/howtos/ways-to-contribute

Your first contribution

Unsure where to begin contributing to FreeSewing? You can start by looking through the issues labeled good first issue.

Don't be afraid to take on an issue. If you get stuck, we'll help you out.