Skip to content

Commit 45d889b

Browse files
authored
feat: add CONTRIBUTING.md
1 parent ef23108 commit 45d889b

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing Guidelines
2+
3+
Thank you for considering contributing to our project! We appreciate your interest in making it better. Please review the following guidelines to help streamline the process.
4+
5+
## Table of Contents
6+
- [Code of Conduct](#code-of-conduct)
7+
- [Getting Started](#getting-started)
8+
- [How to Contribute](#how-to-contribute)
9+
- [Commit Standards](#commit-standards)
10+
- [Styling](#styling)
11+
- [Pull Requests](#pull-requests)
12+
13+
## Code of Conduct
14+
Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md), which we expect all contributors to follow. Respectful and constructive interactions help everyone involved.
15+
16+
## Getting Started
17+
1. Fork the repository.
18+
2. Clone your fork: `git clone https://github.com/your-username/your-forked-repo.git`
19+
3. Create a new branch for each feature or bugfix: `git checkout -b feature/your-feature-name`
20+
4. Make your changes and commit them following the commit standards below.
21+
22+
## How to Contribute
23+
- **Report Issues:** Found a bug or have a suggestion? Feel free to [open an issue](https://github.com/lannodev/angular-tailwind).
24+
- **Submit Enhancements:** If you have an idea for improving the project, please [open an issue](https://github.com/lannodev/angular-tailwind) to discuss it before implementing changes.
25+
- **Help with Documentation:** Improvements to our documentation are always welcome.
26+
27+
## Commit Standards
28+
This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please use the following types in your commit messages:
29+
- `feat:` for new features
30+
- `fix:` for bug fixes
31+
- `docs:` for documentation changes
32+
- `style:` for formatting (non-functional)
33+
- `refactor:` for code changes that do not fix bugs or add features
34+
- `test:` for adding or updating tests
35+
- `chore:` for maintenance
36+
37+
Example commit message:
38+
feat: add user authentication feature
39+
40+
## Styling
41+
This project uses [Tailwind CSS](https://tailwindcss.com/) for styling. Follow our existing patterns and utility classes to ensure consistency. Please avoid adding custom CSS if Tailwind provides a utility that accomplishes the same effect.
42+
43+
## Pull Requests
44+
1. Ensure your changes follow the above guidelines.
45+
2. Make sure all tests pass.
46+
3. Submit the pull request to the `main` branch.
47+
4. Your pull request should:
48+
- Reference related issues if applicable (e.g., `Closes #123`)
49+
- Use a descriptive title following Conventional Commits
50+
5. Our team will review your pull request as soon as possible.
51+
52+
Thank you for your contribution!

0 commit comments

Comments
 (0)