chore(markdown): Redistributed contributor docs
This commit is contained in:
parent
424bb7296a
commit
2b8951bd2d
64 changed files with 35 additions and 39 deletions
26
markdown/dev/howtos/help/en.md
Normal file
26
markdown/dev/howtos/help/en.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: Where to get help
|
||||
for: contributors
|
||||
icons:
|
||||
- help
|
||||
- discord
|
||||
about: |
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
ask questions or share your feedback
|
||||
---
|
||||
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
ask questions or share your feedback.
|
||||
|
||||
Many of the FreeSewing contributors hang out there, and since we're spread over
|
||||
different parts of the world, you're likely to find somebody there who can answer
|
||||
your question(s) at any given moment.
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).
|
||||
|
||||
</Tip>
|
||||
|
||||
|
16
markdown/dev/howtos/ways-to-contribute/body-ambassador/en.md
Normal file
16
markdown/dev/howtos/ways-to-contribute/body-ambassador/en.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Body ambassador
|
||||
---
|
||||
|
||||
Maybe you’re unusually short or tall.
|
||||
Maybe you have a bit of a pot belly or very large breasts.
|
||||
Maybe you have a disability that requires fit adjustments.
|
||||
|
||||
Whatever it is, if you represent a minority fitting issue you could
|
||||
represent this minority to make sure their needs are heard and understood.
|
||||
|
||||
<Tip>
|
||||
|
||||
Join the `#pattern-design` channel on the Discord server and help us understand how we can design patterns that fit people with your body type.
|
||||
|
||||
</Tip>
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Community building
|
||||
---
|
||||
|
||||
The FreeSewing community resides [on Discord](https://discord.freesewing.org/).
|
||||
Just being there to answer questions and chat with other people is a valuable part of community building.
|
||||
|
||||
We also can be found [in plenty of other places](https://freesewing.org/community/where/) where we'd love to have you join us.
|
||||
|
||||
Apart from being present in chat rooms and social media, you could also take on some responsibility on one or more platforms.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Design sewing patterns
|
||||
---
|
||||
|
||||
Everybody wants us to add more patterns. But somebody has to design them.
|
||||
|
||||
That somebody could be you.
|
||||
We can help you with the development side of things.
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Develop sewing patterns
|
||||
---
|
||||
|
||||
You could program new designs for FreeSewing.
|
||||
If you're not afraid of Javascript and are happy to team up with a designer,
|
||||
you could work on a new pattern together.
|
||||
|
10
markdown/dev/howtos/ways-to-contribute/devops/en.md
Normal file
10
markdown/dev/howtos/ways-to-contribute/devops/en.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Devops
|
||||
---
|
||||
|
||||
We have use a lot of automation from Github actions to automated deployment on Netlify.
|
||||
We also have some Ansible playbooks to run maintenance tasks.
|
||||
|
||||
There's also other technical tasks like database or server administration, certificate renewal, and so on.
|
||||
|
||||
If that's your kind of thing, we could use your help.
|
69
markdown/dev/howtos/ways-to-contribute/en.md
Normal file
69
markdown/dev/howtos/ways-to-contribute/en.md
Normal file
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: Ways to contribute
|
||||
---
|
||||
|
||||
Thank you for being part of our community, and for wanting to contribute! ❤️
|
||||
|
||||
FreeSewing is an open source project ran by volunteers from different corners of the world.
|
||||
We would love to have you on board, but before we get to that, let's look at what we expect from you:
|
||||
|
||||
<Note>
|
||||
|
||||
##### Contributor requirements
|
||||
|
||||
- Please respect [our community standards](https://freesewing.org/docs/various/community-standards/)
|
||||
- As a contributor, you must uphold [our Code of Conduct](/contributors/code-of-conduct/)
|
||||
|
||||
</Note>
|
||||
|
||||
With that out of the way, here's a few more things that are *good to know*:
|
||||
|
||||
<Tip>
|
||||
|
||||
##### Did you know?
|
||||
|
||||
- Nobody gets paid to work on/for FreeSewing. We are a 100% volunteer organisation.
|
||||
- We have patrons who support us financially, but all the money that comes in goes to charity --
|
||||
See our [revenue pledge](https://freesewing.org/docs/various/pledge/) for details
|
||||
|
||||
</Tip>
|
||||
|
||||
|
||||
With the formalities out of the way, please continue
|
||||
to [Ways to contribute](/contributors/ways-to-contribute)
|
||||
or [Where to get help](/contributors/help/).
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
##### Looking to hit the ground running?
|
||||
|
||||
You can start with [our project board](https://todo.freesewing.org/), or
|
||||
going through the issues labeled [good first issue](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%91%8D+good+first+issue%22).
|
||||
|
||||
Don't be afraid to take on an issue. If you get stuck, [we'll help you out](https://discord.freesewing.org/).
|
||||
|
||||
</Tip>
|
||||
|
||||
Unsure where to begin contributing to FreeSewing?
|
||||
*Contributing* can take on many shapes and forms.
|
||||
There's certainly a way that works well for you.
|
||||
|
||||
Here's a non-exhaustive list:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
<Note>
|
||||
|
||||
##### Who wants a job in the tech sector?
|
||||
|
||||
For many in our community, contributring to FreeSewing marked their
|
||||
first steps into the world of open source software development.
|
||||
|
||||
We are happy to provide guidance to anyone who wants to learn,
|
||||
especially when doing so enables upwards social mobility.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Make illustrations
|
||||
---
|
||||
|
||||
Our documentation can always use some more/better illustrations to help people figure out how
|
||||
to make our patterns into garments.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Language ambassador
|
||||
---
|
||||
|
||||
You could represent FreeSewing in a non-English community.
|
||||
There, you can help answer questions or triage problem reports.
|
||||
Or you can point out where translations are missing.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Pattern ambassador
|
||||
---
|
||||
|
||||
You could take charge of a specific FreeSewing design/pattern.
|
||||
|
||||
You’ll be the person to ask questions about how to make that pattern.
|
||||
You’ll make sure the documentation is not forgotten.
|
||||
And you can help with questions or triage problem reports to developers or designers.
|
11
markdown/dev/howtos/ways-to-contribute/pattern-testing/en.md
Normal file
11
markdown/dev/howtos/ways-to-contribute/pattern-testing/en.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Pattern testing
|
||||
---
|
||||
|
||||
You could make (a muslin for) our patterns prior to release to make sure everything is ok.
|
||||
|
||||
<Tip>
|
||||
|
||||
Join the `#pattern-design` channel on the Discord server and let us know you would like to help. Here you will find people designing new patterns and reviewing existing patterns. Feedback is very welcome!
|
||||
|
||||
</Tip>
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Project management
|
||||
---
|
||||
|
||||
There's a lot going on within the FreeSewing project and it's easy to forget about something.
|
||||
|
||||
A project manager would be helpful to prioritize tasks, makes sure all tasks have an issue,
|
||||
organize milestones, and so on.
|
||||
|
||||
This is helpful in more than one way:
|
||||
|
||||
- It reduces the cognitive load of the people implementing changes because they don't have to worry about forgetting things
|
||||
- It increases transparency by making it clear what sort of things are being worked on
|
||||
- It gives us that good feeling of closing the issue when the task is done
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Proofreading
|
||||
---
|
||||
|
||||
You could check the original English text of translations for typos and/or grammar mistakes.
|
||||
You could propose improvements and watch over a consistent style and tone across FreeSewing’s documentation and written text.
|
18
markdown/dev/howtos/ways-to-contribute/report-bugs/en.md
Normal file
18
markdown/dev/howtos/ways-to-contribute/report-bugs/en.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Report bugs
|
||||
---
|
||||
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%90%9B+bug&template=bug-report.md&title=Bug+report) if you've found one.
|
||||
|
||||
Explain the problem and include additional details to help maintainers reproduce the problem:
|
||||
|
||||
* **Use a clear and descriptive title** for the issue to identify the problem.
|
||||
* **Describe the exact steps which reproduce the problem** in as many details as possible.
|
||||
* **Include relevant information** such as your username on the site, or the person you drafted a pattern for.
|
||||
|
||||
Provide more context by answering these questions:
|
||||
|
||||
* **Did the problem start happening recently** (e.g. it worked fine before but since the latest update it doesn't)
|
||||
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Showcase our patterns
|
||||
---
|
||||
|
||||
Anytime somebody has made one of our patterns, we like to showcase it on [freesewing.org](https://freesewing.org/showcase/).
|
||||
|
||||
Unpublished showcases are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%91%8D+good+first+issue%2C+%F0%9F%93%B8+showcase%2C+%F0%9F%A4%97+community&template=showcase-template.md&title=Create+showcase+from+this+content) when you've made one of our patterns, or have come across pictures from another maker who did.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Writing for freesewing.dev
|
||||
---
|
||||
|
||||
You could write documentation for freesewing.dev, our developers website.
|
||||
|
||||
You would need good writing skills and a familiarity with code (Javascript).
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Technical writing
|
||||
---
|
||||
|
||||
<ReadMore list />
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Writing for freesewing.org
|
||||
---
|
||||
|
||||
You could write documentation for freesewing.org, our makers website.
|
||||
|
||||
You would need good writing skills and a familiarity with sewing.
|
7
markdown/dev/howtos/ways-to-contribute/translation/en.md
Normal file
7
markdown/dev/howtos/ways-to-contribute/translation/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Translation
|
||||
---
|
||||
|
||||
You could translate FreeSewing into one of its additional languages
|
||||
(French, German, Dutch, Spanish). Or if you’re ambitious, add a new one.
|
||||
|
15
markdown/dev/howtos/ways-to-contribute/triage-issues/en.md
Normal file
15
markdown/dev/howtos/ways-to-contribute/triage-issues/en.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Triage issues
|
||||
---
|
||||
|
||||
Triaging issues is a great way to get involved in FreeSewing. You can do tasks such as:
|
||||
|
||||
- Making sure issues are properly labeled
|
||||
- Ensuring they have a good title that explains the issue in brief
|
||||
- Assigning issues to people to make sure they are tended to
|
||||
- Keeping an eye on stale issues, and either updating or closing them
|
||||
- Assigning issues to milestones so we can plan our releases
|
||||
|
||||
All FreeSewing contributors have triage permissions that allows them to do this.
|
||||
If you don't have the rights, or bump into any issues, [reach out to us on Discord](https://discord.freesewing.org).
|
||||
|
5
markdown/dev/howtos/ways-to-contribute/webdesign/en.md
Normal file
5
markdown/dev/howtos/ways-to-contribute/webdesign/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: UI / UX Webdesign
|
||||
---
|
||||
|
||||
You could help us make our website and tools pretty and improve the user experience.
|
Loading…
Add table
Add a link
Reference in a new issue