|
| 1 | +# Contribute to CSSUI |
| 2 | + |
| 3 | +Take a moment to read this document to make the process simple and consistent with the one used |
| 4 | +from the rest of the team. |
| 5 | + |
| 6 | +## Create an issue |
| 7 | + |
| 8 | +The [issue tracker](https://github.com/italia/bootstrap-italia/issues) is the right place to post bug reports, |
| 9 | +requests for new features and creation of pull requests, in compliance with these conditions: |
| 10 | + |
| 11 | +- please ** do not ** use the issue tracker for personal support requests |
| 12 | +- respect the indications you find below for the use of labels, reporting bugs, and creating pull requests |
| 13 | + |
| 14 | +## Processing an issue |
| 15 | + |
| 16 | +To take charge of an issue, you need to fork the repository on your account, according to the normal GitHub flow. |
| 17 | + |
| 18 | +The flow to follow for the development is simplified compared to a standard git-flow, to allow a greater speed of development, and the creation of a readable history. |
| 19 | + |
| 20 | +Anything in the main (master) branch is defined as stable and potentially deployable. |
| 21 | + |
| 22 | +To work on something new, create a new branch from the master and assign a descriptive name: |
| 23 | +1. in case of a new feature `feat/#[issue_number]-name_of_feature` (ex: feat/#21-new-button-component) |
| 24 | +2. in case of fix `fix/#[issue_number]-bug_title` (ex: fix / focus_textarea_252) |
| 25 | + |
| 26 | + |
| 27 | +At the end of the processing, to propose your code for approval, simply open a Pull Request ( [here](https://help.github.com/articles/creating-a-pull-request-from-a -fork /) the instructions in case of fork). |
| 28 | + |
| 29 | +The criteria to be followed when working on features and issues are as follows: |
| 30 | +- Use the standard [Conventional Commit (https://www.conventionalcommits.org/en/v1.0.0/) to write readable and standardized commit messages |
| 31 | +- In case of several commits on a branch that do not add information to the feature or fix in question (for example fix: revert last work or chore: typo in documentation) it is better to squash the various commits (or ask the merger to do it) the PR in question) |
| 32 | +- Try to align with master before requesting a review, using rebase or merge (https://amerlin.keantex.com/git-merge-vs-rebase/) and resolving any conflicts. |
| 33 | + |
| 34 | +## Issue and label |
| 35 | + |
| 36 | +The CSSUI repository uses some labels to identify issues: |
| 37 | +- `documentation`, improvements or additions to the documentation |
| 38 | +- `bug`, something isn't working on stable branch `main` |
| 39 | +- `duplicate`, this issue or pull request already exists |
| 40 | +- `enhancement`, new feature or request |
| 41 | +- `help wanted`, extra attention is needed |
| 42 | +- `invalid`, this doesn't seem right |
| 43 | +- `question`, further information is needed |
| 44 | +- `status: in progress`, cooking something |
| 45 | +- `status: merged`, identify issues merged in `dev` branch |
| 46 | +- `status: released`, identify issues released in `main` branch |
| 47 | + |
| 48 | +## License |
| 49 | + |
| 50 | +By contributing to the code or documentation you agree to release your code under the open source license already present in the repository. |
0 commit comments