Skip to content

Latest commit

 

History

History
162 lines (115 loc) · 6.76 KB

CONTRIBUTING.md

File metadata and controls

162 lines (115 loc) · 6.76 KB
Raw

Contributing

If you are on this page it means you are almost ready to contribute proposing changes, fixing issues or anything else about Decathlon Design System libraries for web applications. So, thanks a lot for this!! 🎉👍

Table of Contents

Overview

Yarn workspaces and nx are used to manage dependencies and build config across package. Lerna is used to manage versioning & publishing.

Project structure

vitamin-web/
  lerna.json
  package.json
  ...
  packages/
    showcases/
      core/
      css/
      icons/
      react/
      svelte/
      vue/
    sources/
      assets/
      css/
      icons/
      react/
      svelte/
      vue/

Local development

Run the following to setup your local dev environment:

# Install `yarn`, alternatives at https://yarnpkg.com/en/docs/install
brew install yarn

# Clone or fork `vitamin-web`
git clone [email protected]:Decathlon/vitamin-web.git # or your fork
cd vitamin-web

# install dependencies
yarn

# build packages
yarn build

To develop in watch mode and run all showcases with hot reloads, just run:

# start all showcases and build sources in watch mode & hot reload
yarn start
# or if you need don't need to launch every packages, you can launch separately:
yarn start:css
yarn start:icons
yarn start:react
yarn start:svelte
yarn start:vue

For your information, here are the showcases' URLs:

Showcase URL
CSS localhost:6006
Icons localhost:6007
React localhost:6008
Svelte localhost:6009
Vue localhost:6010

Code of conduct

This project and everyone participating in it is governed by the following code of conduct. By participating, you are expected to uphold this code.

What are you talking about? Pull Request? Merge? Push?

If you are not familiar with Git and GitHub terms you can check a complete glossary on the GitHub website.

How can I contribute?

Reporting an issue

The first way to contribute to a project is simply proposing an issue. If you find anything which is not working well or as expected you can open an issue.

Before to open the issue please check if there is one similar already opened. It will save us hours of work and it will allow us to answer you quickly with the desired hotfix or implementation.

NOTE: if looking for existing issues you will find the same problem, or similar, in closed state, please refer to this issue (with its number) when you are opening your one. It is maybe a regression we didn't see. In this way you will help to go faster and to find a definitive solution to the recurrent problem.

When you are opening an issue, please be sure to report as much information as you can to allow us to replicate the problem and faster find the solution.

Code contribution

If you are a dev and you want to directly fix a problem or implement a new feature... you are the best one! 👏👏

To help you follow the progress, we have this project board: https://github.com/orgs/Decathlon/projects/3

To propose any change you have to submit us a Pull Request

The workflow we are using is:

  1. Fork this repository (as you don't have a direct write access to the main one.
  2. Create your code, Commit and Push the code on your forked repo
  3. Create a GitHub Pull Request to our main branch (which is the main one for the coming version).

We will take the time to review your code, make some comments or asking information if needed. But, as you took time to help us, we will take in serious consideration what you are proposing. To quickly have your code available on production, please take care and read our Contribution acceptance criteria

Commit and push on your branch

git add <files>
git commit -m "<type>[optional scope]: <description>" (the message must follow https://www.conventionalcommits.org guidelines)
git push origin <my-branch-name>

Pull Request guidelines

When you open your Pull Request provide as much information as possible.

  • For an issue, describe what you are fixing with your pull request and how you had found the defect.
  • If you are proposing an enhancement, describe what you are adding to the code (new function, performance enhancement, documentation update, changing an existing function, ...).

Publish canary version

On your newest pull request, it is possible to publish a canary version in order to test it on your project before the final publish. Why this ? Is to avoid all side effects on the components / css. You can make changes and test it before on your application before the release.

To do that, you can apply the label "Publish canary 🐥" on your PR. A new github action will execute to publish a canary.

Contribution acceptance criteria

We love maintenable software and we are happy when some else than us is able to take the code, understand it and be able to change it. To reach this goal we fixed some rule in our team and we would love to go ahead in this way, even with the external contribution:

  1. Be sure your code compile: no syntax error, no missing library, ...
  2. Add comments on the code if you want to explain better what is happening in the code.
  3. Add documentation for any API, if needed, or functional explaining what changed/added with your code.
  4. After you proposed the PullRequest. If you will receive any mail or find any automatic comment on the Pull Request you opened, it means there is something which is not respecting the project defined code style.

If you respect all these rules you will help us saving time and we will be able to check your pull request faster.