diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2754f3cc..7cf8ad52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,10 @@ Generally it's fine to just work on these kinds of things and put a pull-request If you want to find something to fix or work on keep a look out for the [`bug`](https://github.com/Myriad-Dreamin/tinymist/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and [`enhancement`](https://github.com/Myriad-Dreamin/tinymist/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) labels. Among issues, the [`good first issue`](https://github.com/Myriad-Dreamin/tinymist/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label is a good place to start. +## Localization + +Tinymist is localized in multiple languages. You can contribute to the localization of Tinymist by translating or correcting the locale files in the [locales](./locales) folder. This is also a good start of contributing to the project. + ## Implementing a new feature It's advised to first open an issue for any kind of new feature so the team can tell upfront whether the feature is desirable or not before any implementation work happens. We want to minimize the possibility of someone putting a lot of work into a feature that is then going to waste as we deem it out of scope (be it due to generally not fitting in with tinymist, or just not having the maintenance capacity). If there already is a feature issue open but it is not clear whether it is considered accepted feel free to just drop a comment and ask! diff --git a/README.md b/README.md index f163eac5..a6dbdb21 100644 --- a/README.md +++ b/README.md @@ -169,19 +169,6 @@ If you are interested by any above features, please feel free to send Issues to Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for contribution guidelines. -## Localization - -Tinymist is localized in multiple languages. You can contribute to the localization of Tinymist by translating or correcting the locale files in the [locales](./locales) folder. This is also a good start of contributing to the project. - -## Maintainers - -Get list of maintainers from [Maintainers Page](https://github.com/Myriad-Dreamin/tinymist/blob/main/MAINTAINERS.md). Or programmatically by `yarn maintainers` - -> [!NOTE] -> -> You can add extra arguments for specific information. For example, `yarn maintainers --input="action=maintainers"`. - - ## Sponsoring Tinymist thrives on community love and remains proudly independent. While we don't accept direct project funding, we warmly welcome support for our maintainers' personal efforts. Please go to [Maintainers Page](https://github.com/Myriad-Dreamin/tinymist/blob/main/MAINTAINERS.md) and [Contributors Page](https://github.com/Myriad-Dreamin/tinymist/graphs/contributors) and find their personal pages for more information. It is also welcomed to directly ask questions about sponsoring on the [GitHub Issues](https://github.com/Myriad-Dreamin/tinymist/issues/new). diff --git a/docs/tinymist/introduction.typ b/docs/tinymist/introduction.typ index 66cfa6e2..ae891f2e 100644 --- a/docs/tinymist/introduction.typ +++ b/docs/tinymist/introduction.typ @@ -119,18 +119,6 @@ If you are interested by any above features, please feel free to send Issues to Please read the #link("CONTRIBUTING.md")[CONTRIBUTING.md] file for contribution guidelines. -== Localization - -Tinymist is localized in multiple languages. You can contribute to the localization of Tinymist by translating or correcting the locale files in the [locales](./locales) folder. This is also a good start of contributing to the project. - -== Maintainers - -Get list of maintainers from #link("https://github.com/Myriad-Dreamin/tinymist/blob/main/MAINTAINERS.md")[Maintainers Page]. Or programmatically by `yarn maintainers` - -#note-box[ - You can add extra arguments for specific information. For example, `yarn maintainers --input="action=maintainers"`. -] - == Sponsoring Tinymist thrives on community love and remains proudly independent. While we don't accept direct project funding, we warmly welcome support for our maintainers' personal efforts. Please go to #link("https://github.com/Myriad-Dreamin/tinymist/blob/main/MAINTAINERS.md")[Maintainers Page] and #link("https://github.com/Myriad-Dreamin/tinymist/graphs/contributors")[Contributors Page] and find their personal pages for more information. It is also welcomed to directly ask questions about sponsoring on the #link("https://github.com/Myriad-Dreamin/tinymist/issues/new")[GitHub Issues].