search

DazzlingFugu / ember-fr-guides-source

The EmberGuides for French-speakers
https://master--ember-fr-guides.netlify.app
MIT License
5 stars 5 forks source link
ember emberjs francais french guide hacktoberfest

readme

This project uses GitHub Actions for continuous integration.

Ember.js Guides, French Source

This repository contains the French translation of the official Ember.js Guides:

Contributing

Welcome and thanks for your help!

First-time contributors are encouraged to look at issues that are labeled help wanted or good first issue. If you have questions or want a buddy to pair with, you can join the #lang-french in the Ember Community Discord.

Please see CONTRIBUTING.md for additional instructions on how to format your work and submit a PR.

The Ember French Guides content is written in Markdown. In general, your PR should make edits to only the files in the /guides/release directory, which corresponds to the latest version of Ember.

Local development

NOTE: This project uses Volta to ensure the correct Node.js and NPM version is used during local development.

To run the Ember Guides app locally, type these commands into your terminal:

git clone git://github.com/DazzlingFugu/ember-fr-guides-source.git

cd ember-fr-guides-source
npm install
ember serve

Afterwards, visit http://localhost:4200 in your browser.

Note: On Mac, if you get the error Error: EMFILE: too many open files, watch, try installing Watchman. Install Homebrew if you don't have it. Then, in your terminal, run brew install watchman

Linting and spellchecking

The guides are spellchecked and linted for Markdown consistency. You can check your edits by running,

npm run lint

Linting and spellchecking must pass or they will fail in CI (continuous integration). See CONTRIBUTING.md for more information on linting and spellchecking.

Internal and external links

Testing of internal and external links can be performed using three commands:

# Run all test scripts in `/node-tests` except those located
# in `/node-tests/local`. In particular, this command checks
# all internal links across the French Guides.
npm run test:node

# Run all test scripts in `/node-tests/local`. In particular,
# this command checks all external links in the release version
# of the Guides and across all versions of the official Guides.
npm run test:node-local

# When checking external links in the release version, don't
# check links to the API docs (https://api.emberjs.com).
npm run test:node-local-exclude-api-urls