Skip to content

Commit

Permalink
chore: update information on how to contribute and what is involved i…
Browse files Browse the repository at this point in the history 
…n maintainership (#214)

Co-authored-by: Espen Hovlandsdal <[email protected]>
  • Loading branch information
@runeb @rexxars
runeb and rexxars authored Jan 5, 2024
1 parent f133ee7 commit 1ccdeda
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
48 changes: 29 additions & 19 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,41 +1,38 @@
# Contributing

Contributions are always welcome!
Contributions are always welcome and there are multiple ways to join in from being a maintainer of a particular locale to submitting one-off improvement suggestions, big or small. Maintainers are tagged to help review automated pull-requests from AI and receive a token of appreciation from Sanity.

## Getting started

Before contributing, please read our [code of conduct](https://github.com/sanity-io/locales/blob/main/CODE_OF_CONDUCT.md).

Then make sure you have [Node.js](https://nodejs.org/en) _version 18.3 or newer_, as well as [pnpm](https://pnpm.io/).

```sh
git clone [email protected]:sanity-io/locales.git
cd locales
pnpm install
pnpm run build
```

## Suggesting improvements

The strings are located in the src folder of each plugin, where the file name represents the "namespace". Send a pull request if you have suggestions for improvements, and feel free to add yourself to the contributors array in locales/registry.ts. If you want to help review new translations, add yourself to the maintainers array instead, see below for more information. After doing your changes, run pnpm run reconcile and add the changes to version control.
You can easily add suggestions to existing pull requests from AI and other contributors without checking out code, here is a quick demo:

## Maintaining a locale
[![Demo of making suggestions](https://github.com/sanity-io/locales/assets/38528/6b49bd12-ac44-4471-881f-b3168e97b5f7)](https://www.loom.com/share/4ae37eb58985467fb9f68498ce669038?sid=a5d3dc37-22d2-4a78-8452-5ae7039f11e1)

Want to help maintain a plugin? Awesome! We appreciate your help! To get started can either [request to be added as a maintainer](https://github.com/sanity-io/locales/issues/new?assignees=&labels=&projects=&template=request-maintainer.md&title=Maintainer%3A+LOCALE-ID), or add yourself as one by following these steps:
### Submitting your own PRs

1. Follow the [Getting started](#getting-started) instructions
2. Add yourself to the `maintainers` array in the `locales/registry.ts` file for the language you have in mind.
3. Run `pnpm run reconcile` - it should update a few files, such as `package.json` for the given locale.
4. Add the changes to git, commit the changes and push to a fork.
Make sure you have Node.js version 18.3 or newer, as well as pnpm.

- Preferably the commit message (and PR name) should be something like "chore(<locale-id>): add @<your-github-username> as maintainer".
```bash
git clone [email protected]:sanity-io/locales.git
cd locales
pnpm install
pnpm run build
```

5. Send a pull request!
The strings are located in the `src` folder of each plugin, where the file name represents the "namespace". Send a pull request if you have suggestions for improvements, and feel free to add yourself to the contributors array in locales/registry.ts. If you want to help review new translations, add yourself to the maintainers array instead, see below for more information. After doing your changes, run pnpm run reconcile and add the changes to version control.

## Adding a new locale

Hooray! We appreciate your contribution and love seeing new locales added! Initially, you probably do not want to hand-translate every single string in the studio. Instead, simply [request a new locale](https://github.com/sanity-io/locales/issues/new?assignees=&labels=&template=new-locale-request.md&title=Locale+request%3A+) and we will run an initial AI translation for you. Once this is done, you can contribute edits/improvments to it and optinally be its maintainer.

Here is a full walkthrough of how we use AI to help us create language plugins and keep them updated, and how maintainers and contributors help

[![Demo of adding languages with AI](https://github.com/sanity-io/locales/assets/38528/e0de83ad-7b95-407c-b355-a610479dfbaf)](https://www.loom.com/share/f75d227a116c4df2a3c0d2b675842bec?sid=03c7d4b6-3d0a-4575-b65a-d5247368b30d)

Should you want to manually translate or otherwise work directly with the source code, here are the steps involved:

1. Create a new branch for your work (`git checkout -b feat/add-locale-<locale-id>`).
Expand All @@ -53,6 +50,19 @@ Should you want to manually translate or otherwise work directly with the source
- Note: The reconciliation script will make changes to `pnpm-lock.yaml`, `apps/studio` and possibly `locales/registry.ts` (if not sorted correctly). This is expected, and should be commited.
7. Push your changes to a fork and send a pull request!

## Maintaining a locale

Want to help maintain a plugin? Awesome! We appreciate your help! To get started, either [request to be added as a maintainer](https://github.com/sanity-io/locales/issues/new?assignees=&labels=&projects=&template=request-maintainer.md&title=Maintainer%3A+LOCALE-ID), or add yourself as one by following these steps:

1. Follow the [Getting started](#getting-started) instructions
2. Add yourself to the `maintainers` array in the `locales/registry.ts` file for the language you have in mind.
3. Run `pnpm run reconcile` - it should update a few files, such as `package.json` for the given locale.
4. Add the changes to git, commit the changes and push to a fork.

- Preferably the commit message (and PR name) should be something like "chore(<locale-id>): add @<your-github-username> as maintainer".

5. Send a pull request!

## Troubleshooting

If you run into build issues, you might want to try deleting `node_modules` folders and reinstalling dependencies with `pnpm install`.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Don't see your preferred locale here? [Request a new locale](https://github.com/

## Maintainers

We keep these packages automatically updated with AI but we would like community contributors to help review changes and improve the AI translations. If you would like to participate please use the "Join" link next to your locale or submit a Request Maintainer issue from the Issues tab. You can still request to join if a package already has maintainers.
We keep these packages automatically updated with AI but we would like community contributors to help review changes and improve the AI translations. If you would like to participate please use the "Join" link next to your locale or submit a Request Maintainer issue from the Issues tab. Maintainers receive a token of appreciation from Sanity. You can still request to join if a package already has maintainers.

More information on being a maintainer, contributing to this project and a demo of how we use AI to create and keep translations updated can be found in [CONTRIBUTING.md](CONTRIBUTING.md)

## Current locales

Expand Down

0 comments on commit 1ccdeda

Please sign in to comment.