Skip to content

Commit

Permalink
Merge pull request #2726 from LuccaSA/tweak-contributing.md
Browse files Browse the repository at this point in the history
Update contributing.md
  • Loading branch information
fbasmaison-lucca authored Apr 12, 2024
2 parents e649d31 + 919c8e5 commit 926e47d
Showing 1 changed file with 26 additions and 35 deletions.
61 changes: 26 additions & 35 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,55 @@
# Contributing to Lucca Front

Use english
We use english.

- [Questions or Problem](#qop)
- [Issues and Bugs](#issue)
- [Coding Rules](#rules)
- [Submission Guidelines](#submit)

## <a name="qop"></a> Questions or Problems ?
## <a name="qop"></a> Questions or Problems?

Post a message on [slack] https://lucca.slack.com/archives/C3W78FWUU
Post a message on [slack](https://lucca.slack.com/archives/C3W78FWUU).

## <a name="issue"></a> Issues or Bugs
## <a name="issue"></a> Issues or Bugs

Create an issue on [Github] https://github.com/LuccaSA/lucca-front/issues
You can also post a message on [slack] https://lucca.slack.com/archives/C3W78FWUU
Create an issue on [Github](https://github.com/LuccaSA/lucca-front/issues).

You can also post a message on [slack](https://lucca.slack.com/archives/C3W78FWUU).

## <a name="rules"></a> Coding Rules

### For package Icons
### Icons

Follow our [tutorial on Notion](https://www.notion.so/Mise-jour-de-la-font-36363b23cdf0470a920f68d2c5f436a7) (🇫🇷)

### For Package Scss
### SCSS files

Follow our [tutorial on Prisme](https://prisme.lucca.io/94310e217/p/929c63-intgration) (🇫🇷)

:wip: TODO directory structure

### For package Ng
🚧 TODO directory structure

:wip: TODO with the frontend guild
### Angular

🚧 TODO with the frontend guild

## <a name="submit"></a> Submission Guidelines
### Submitting a Pull Request (PR)

For PR name format, use the name of the component to prefix the PR title

\[{ComponentName}\] A short description

When a component, an icon or a class scss is added or modified, verify all this point :

- Add or modify Stories. Check the documentation in the stories and update if necessary
- For the ng components, add or modify unit test
- :wip: UiDiff

Add a label "Technical", "Feature" or "Issue"
Add a label "Documentation changes" when a stories is added or modified
### Submitting a Pull Request (PR)

Check the build before post the PR on [slack](https://lucca.slack.com/archives/C0308N9RPF0)
1. Prefix the PR title with the name of the component:
_**\[{ComponentName}\]** A short description_
2. When a component, an icon or an scss class is added or modified, check the following:
- Stories are updated or created: Check the documentation in the stories and update if necessary.
- Unit tests are updated or created for ng components.
- 🚧 UiDiff.
3. Add a label "Technical", "Feature" or "Issue".
4. Add a label "Documentation changes" when a stories is added or modified.
5. Check the build before posting the PR on [slack](https://lucca.slack.com/archives/C0308N9RPF0).

### Submitting an issue or a feature

Add a [Github issue](https://github.com/LuccaSA/lucca-front/issues)
Add a label "Guilde Front" or/and "Guilde Design"
Add a label "Feature" or "Issue"

Create a branch from master for the current milestone or form the tag version when a bug target a specific verion
For a bug, specify all versions impacted



1. Add a [Github issue](https://github.com/LuccaSA/lucca-front/issues).
2. Add a label "Feature" or "FIX".
3. Add the appropriate labels ("Front", "Design sync"…).
4. Create a branch from the "rc" branch for the current milestone, or from the tag version when a bug target a specific version. For a bug, specify all versions impacted.

0 comments on commit 926e47d

Please sign in to comment.