2
2
mirror of https://github.com/Thream/website.git synced 2024-07-21 09:28:32 +02:00
website/CONTRIBUTING.md

64 lines
3.1 KiB
Markdown
Raw Normal View History

2021-10-24 05:19:39 +02:00
# 💡 Contributing
Thanks a lot for your interest in contributing to **Thream/website**! 🎉
## Code of Conduct
**Thream** has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
## Open Development
All work on **Thream/website** happens directly on [GitHub](https://github.com/Thream). Both core team members and external contributors send pull requests which go through the same review process.
## Types of contributions
- Reporting a bug.
- Suggest a new feature idea.
2021-10-24 05:48:06 +02:00
- Correct spelling errors, improvements or additions to documentation files.
2021-10-24 05:19:39 +02:00
- Improve structure/format/performance/refactor/tests of the code.
## Pull Requests
2021-10-24 05:48:06 +02:00
- **Please first discuss** the change you wish to make via issues.
2021-10-24 05:19:39 +02:00
2022-03-21 16:12:22 +01:00
- Ensure your code respect linting.
2021-10-24 05:19:39 +02:00
- Make sure your **code passes the tests**.
If you're adding new features to **Thream/website**, please include tests.
## Commits
2021-10-24 05:48:06 +02:00
The commit message guidelines respect
[@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
and [Semantic Versioning](https://semver.org/) for releases.
2021-10-24 05:19:39 +02:00
### Types
Types define which kind of changes you made to the project.
| Types | Description |
| -------- | ------------------------------------------------------------------------------------------------------------ |
| feat | A new feature. |
| fix | A bug fix. |
| docs | Documentation only changes. |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
| refactor | A code change that neither fixes a bug nor adds a feature. |
| perf | A code change that improves performance. |
| test | Adding missing tests or correcting existing tests. |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
| chore | Other changes that don't modify src or test files. |
| revert | Reverts a previous commit. |
### Scopes
Scopes define what part of the code changed.
2021-10-24 05:48:06 +02:00
### Examples
```sh
git commit -m "feat(components): add Button"
git commit -m "docs(readme): update installation process"
```