|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing! Please feel free to put up a PR for any issue, feature request or enhancement. |
| 4 | + |
| 5 | +Even if you have little to no experience with Tailwindcss, JavaScript or React, we'd be more than happy to help you with any information or guidance in order to fulfill your PR. |
| 6 | + |
| 7 | +## Reporting issues & features requests |
| 8 | + |
| 9 | +If you notice any bugs in the code, see some code that can be improved, or have features you would like to be added, please create a [bug report](https://github.com/tailwindjs/react-tailwindjs/issues/new?template=bug-report---.md) or a [feature request](https://github.com/tailwindjs/react-tailwindjs/issues/new?template=feature-request---.md)! |
| 10 | + |
| 11 | +If you want to open a PR that fixes a bug or adds a feature, then we can't thank you enough! |
| 12 | + |
| 13 | +## Working on issues |
| 14 | + |
| 15 | +Please feel free to take on any issue that's currently open. Just send a comment in order to let us know you're working on it so we can assign that specific issue to you. |
| 16 | + |
| 17 | +## Submitting a pull request |
| 18 | + |
| 19 | +Tailwindjs/react-tailwindjs is an open-source project, so pull requests are always welcomed (_always_ ❤️). |
| 20 | +What we ask you, is that before working on a large change, it is best to open an issue first to discuss it with the maintainers or if an issue was already opened, comment your intention of opening up a PR. |
| 21 | + |
| 22 | +When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one. |
| 23 | + |
| 24 | +### Branch types |
| 25 | + |
| 26 | +1. **Feature** - New implementation code that is required for product development. Everything that is not considered a defect and brings value is considered a feature. Example: **feature/GBXB-483-enable-SSR** |
| 27 | +2. **Bug** - Defects, either flagged by the QA team or any of the parties involved in the project, missing functionality or wrongly implemented functionality, they all fall into the “bug” category. Branches that solve such defects should be prefixed with the **bug** prefix. Example: **bug/GBXB-441-fix-double-spending** |
| 28 | +3. **Chore** — Miscellaneous work not related to the project code. For example, updating node module versions, renaming an environment configuration file or removing unused variables. Example: **chore/rename-dotenv-preference-file** |
| 29 | +4. **Docs** — Any work that relates to project-level and code-level documentation. Whether it is work related to the project **README**, or code-level documentation, branches that host this type of work should use this prefix. Example: **docs/GBXB-483-enable-SSR** |
| 30 | + |
| 31 | +### Commit formatting |
| 32 | +Every file changed should have its own commit message and each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: |
| 33 | +``` |
| 34 | +<type>(<scope>): <subject> |
| 35 | +<BLANK LINE> |
| 36 | +<body> |
| 37 | +<BLANK LINE> |
| 38 | +<footer> |
| 39 | +``` |
| 40 | +From the above template, only the **header** is mandatory (_note_: the **scope** of the header is not mandatory) and the **header** should not be longer than 100 characters! |
| 41 | + |
| 42 | +#### Type |
| 43 | +Can only be one of the following: |
| 44 | + |
| 45 | +* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| 46 | +* **docs**: Documentation only changes |
| 47 | +* **feat**: A new feature |
| 48 | +* **fix**: A bug fix |
| 49 | +* **perf**: A code change that improves performance |
| 50 | +* **refactor**: A code change that neither fixes a bug nor adds a feature |
| 51 | +* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| 52 | +* **test**: Adding missing tests or correcting existing tests |
| 53 | + |
| 54 | +#### Scope |
| 55 | +The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages). |
| 56 | + |
| 57 | +#### Subject |
| 58 | +The subject is a succint description of what this commit does. |
| 59 | + |
| 60 | +#### Body |
| 61 | +A large detail, if needed, of what this commit does. |
| 62 | + |
| 63 | +#### Footer |
| 64 | +The footer should only contain a closing statement for an issue. |
| 65 | + |
| 66 | +#### Samples: |
| 67 | +``` |
| 68 | +docs(changelog): update changelog to v1.0.0 |
| 69 | +``` |
| 70 | +``` |
| 71 | +refactor: change alert code |
| 72 | +
|
| 73 | +With this new code, the alert will respond faster to user interactions (such as closing the alert). |
| 74 | +
|
| 75 | +Closes #12 |
| 76 | +``` |
| 77 | + |
| 78 | +## Branches explained |
| 79 | + |
| 80 | +As you can see we have multiple branches: |
| 81 | + - **master**: This branch stores the latest stable version of tailwindjs/react-tailwindjs. |
| 82 | + - **dev-master**: This is the **development** branch of tailwindjs/react-tailwindjs, and this is where everything is happening before releasing on master |
0 commit comments