Skip to content

Commit

Permalink
Update docs with pre-commit skip + i18n $t ignore method
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Dec 8, 2024
1 parent e2eef79 commit 3f0c5c3
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,13 @@ When making a contribution, adhering to the [GitHub flow](https://docs.github.co
> pip install pre-commit
> ```
> [!NOTE]
> If you are having issues with pre-commit and want to send along your changes regardless, you can ignore the pre-commit hooks via the following:
>
> ```bash
> git commit --no-verify -m "COMMIT_MESSAGE"
> ```
4. Commit your changes in logical chunks, and please try to adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
> [!NOTE]
Expand Down Expand Up @@ -517,6 +524,20 @@ Localization for activist happens on our [public localization project on Weblate
To find issues related to localization, please see the [`localization`](https://github.com/activist-org/activist/issues?q=is%3Aopen+is%3Aissue+label%3Alocalization) label in the [issues](https://github.com/activist-org/activist/issues), and to report a localization issue use the [localization issue form](https://github.com/activist-org/activist/issues/new?assignees=&labels=localization&projects=activist-org%2F1&template=localization.yml). Please also see the [style guide](STYLEGUIDE.md) for more information on how to create new localization keys.
> [!IMPORTANT]
> If you're having issues with the vue/nuxt i18n `$t` local property not being picked up by TypeScript and being reported as invalid/not existing across the codebase, then please add the following file at `frontend/types/vue-i18n.d.ts`:
>
> ```ts
> // frontend/types/vue-i18n.d.ts
> // Attn: Fixes Property '$t' does not exist on type ... errors.
> // Note: This file is git ignored, but can be used as a local fix for excessive TypeScript errors.
> declare module "vue" {
> interface ComponentCustomProperties {
> $t: (key: string) => string;
> }
> }
> ```
<a id="documentation-"></a>
## Documentation [`⇧`](#contents)
Expand Down

0 comments on commit 3f0c5c3

Please sign in to comment.