mirror of
https://github.com/Paris-est-Ludique/intranet.git
synced 2025-06-08 00:24:21 +02:00
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# Contributing to FORCE ORANGE
|
||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
|
||
|
||
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
||
|
||
> Working on your first Pull Request? You can learn how from [this free video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
|
||
|
||
## Pull Request Process
|
||
|
||
1. Fork the repository and create your branch from `master`.
|
||
2. Run `yarn` to install dependencies.
|
||
3. If you’ve fixed a bug or added code that should be tested.
|
||
4. Ensure the test suite passes by running `yarn test`.
|
||
5. Update the [README.md](README.md) with details of changes.
|
||
6. Make sure your code lints by running `yarn lint`.
|
||
|
||
## Development Workflow
|
||
|
||
After cloning REACT COOL STARTER, run `yarn` to fetch its dependencies. Then, you can run [several commands](https://github.com/forceoranj/intranet#script-commands).
|
||
|
||
## Style Guide
|
||
|
||
We use [ESLint](https://eslint.org), [StyleLint](https://stylelint.io) and [Prettier](https://prettier.io) for code style and formatting. Run `yarn lint` after making any changes to the code. Then, our linter will catch most issues that may exist in your code.
|
||
|
||
However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at [Airbnb’s Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.
|
||
|
||
## License
|
||
|
||
By contributing to REACT COOL STARTER, you agree that your contributions will be licensed under its MIT license.
|