Skip to content

Commit f7ca38a

Browse files
authored
feat(chore): Minimal github conventions (#1530)
ref: WEB-2430
1 parent 6cd0ecd commit f7ca38a

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,10 @@ React component library for Telefonica's Design System.
2121
- If you create a new component always create a snippet for playroom.
2222
- If you add props to a component always update stories accordingly and add the new props to args and
2323
argTypes.
24+
25+
---
26+
27+
## GitHub conventions
28+
29+
- Read [CONTRIBUTING](./CONTRIBUTING.md) before contributing to Mistica repo.
30+
- Always add the `AI` label to PRs where the code was written by an AI agent.

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ Don't hesitate to ask any questions and share your ideas
2121
We would love to accept your Pull Requests but please, before starting your development,
2222
[create an issue](https://github.com/Telefonica/mistica-web/issues/new/choose).
2323

24+
- PR title must follow **conventional commits** format; the scope must be the affected **component name**
25+
(e.g. `fix(TextField): ...`). If no component was affected but the change is internal you can use set
26+
"Chore" as the component name. For allowed types check [lint action](./.github/workflows/lint-pr.yml).
27+
- PR description: concise summary of the problem and fix, ending with `Ref: <TICKET-ID>` (if there's a jira
28+
ticket).
29+
- Always add reviewers `aweell`, `atabel`, `yceballost` and `Marcosld` to every PR.
30+
2431
## Bug reports
2532

2633
If something is broken or not working as expected, let us know!

0 commit comments

Comments
 (0)