Ver Fonte

docs: Add some more info on contributing

Michael Bromley há 5 anos atrás
pai
commit
32a15c906d
2 ficheiros alterados com 17 adições e 5 exclusões
  1. 15 3
      CONTRIBUTING.md
  2. 2 2
      packages/admin-ui/README.md

+ 15 - 3
CONTRIBUTING.md

@@ -4,11 +4,11 @@ Hi! Thank you for taking the time to contribute to Vendure!
 
 In order to make the best use of both your time and that of the Vendure maintainers, please follow the guidelines in this document.
 
-## Bug Fixes
+## Bug fixes
 
 If you would like to contribute a bugfix, please first create an issue detailing the bug, and also indicate that you intend to fix it. When creating commits, please follow the commit message format below.
 
-## New Features
+## New features
 
 Again, please create a feature request detailing the functionality you intend to add, and state that you would like to implement it. When creating commits, please follow the commit message format below.
 
@@ -40,7 +40,7 @@ type(scope): Message in present tense
 * email-plugin
 * etc.
 
-If a commit affects more than one package, seperate them with a comma:
+If a commit affects more than one package, separate them with a comma:
 
 ```
 fix(core,common): Fix the thing
@@ -48,6 +48,18 @@ fix(core,common): Fix the thing
 
 If a commit applies to no particular package (e.g. a tooling change in the root package.json), the scope can be omitted.
 
+#### Breaking Changes
+
+If your contribution includes any breaking changes (including any changes to the DB schema; backwards-incompatible changes to the GraphQL APIs or VendureConfig; backwards-incompatible changes to current behavior), please include a `BREAKING CHANGE` section in your commit message as per the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with-both-and-breaking-change-footer).
+
 #### Linting
 
 Commit messages are linted on commit, so you'll know if your message is not quite right.
+
+## Setting up the dev environment
+
+After cloning the Vendure repo, please follow the [Development guide](https://github.com/vendure-ecommerce/vendure/blob/master/README.md#development) in the README for instructions on how to get up and running locally.
+
+## Contributing Admin UI translations
+
+If you wish to contribute translations of the Admin UI into another language (or improve an existing set of translations), please see the [Localization guide](https://github.com/vendure-ecommerce/vendure/blob/master/packages/admin-ui/README.md#localization) in the admin-ui package.

+ 2 - 2
packages/admin-ui/README.md

@@ -33,6 +33,6 @@ Translation keys are automatically extracted by running:
 ```
 yarn extract-translations
 ```
-This will add any new translation keys to the default language file located in [`./src/i18n-messages/en.json`](./src/i18n-messages/en.json).
+This will add any new translation keys to the default language file located in [`./src/lib/static/i18n-messages/en.json`](./src/lib/static/i18n-messages/en.json).
 
-From this master translation file, other language versions can be created by copying and updating the values for the new language.
+To extract translations into other language, run the same command as specified in the `extract-translations` npm script, but substitute the "en" in "en.json" with the [ISO 639-1 2-character language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for that language.