Skip to content

Commit e795fb0

Browse files
committed
AI Generated README
1 parent 963119d commit e795fb0

File tree

4 files changed

+846
-5
lines changed

4 files changed

+846
-5
lines changed

CONTRIBUTING.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Contributing to go-redis-entraid
2+
3+
We welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Create a new branch for your feature or bugfix
9+
3. Make your changes
10+
4. Run the tests and ensure they pass
11+
5. Submit a pull request
12+
13+
## Development Setup
14+
15+
```bash
16+
# Clone your fork
17+
git clone https://github.com/your-username/go-redis-entraid.git
18+
cd go-redis-entraid
19+
20+
# Install dependencies
21+
go mod download
22+
23+
# Run tests
24+
go test ./...
25+
```
26+
27+
## Code Style and Standards
28+
29+
- Follow the Go standard formatting (`go fmt`)
30+
- Write clear and concise commit messages
31+
- Include tests for new features
32+
- Update documentation as needed
33+
- Follow the existing code style and patterns
34+
35+
## Testing
36+
37+
We maintain high test coverage for the project. When contributing:
38+
39+
- Add tests for new features
40+
- Ensure existing tests pass
41+
- Run the test coverage tool:
42+
```bash
43+
go test -coverprofile=cover.out ./...
44+
go tool cover -html=cover.out
45+
```
46+
47+
## Pull Request Process
48+
49+
1. Ensure your code passes all tests
50+
2. Update the README.md if necessary
51+
3. Update the version number in `version.go` if making a significant change
52+
4. Submit your pull request with a clear description of the changes
53+
54+
## Reporting Issues
55+
56+
If you find a bug or have a feature request:
57+
58+
1. Check the existing issues to avoid duplicates
59+
2. Create a new issue with:
60+
- A clear title and description
61+
- Steps to reproduce (for bugs)
62+
- Expected and actual behavior
63+
- Environment details (Go version, OS, etc.)
64+
65+
## Code of Conduct
66+
67+
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
68+
69+
## Development Workflow
70+
71+
1. Create a new branch for your feature/fix:
72+
```bash
73+
git checkout -b feature/your-feature-name
74+
```
75+
76+
2. Make your changes and commit them:
77+
```bash
78+
git add .
79+
git commit -m "Description of your changes"
80+
```
81+
82+
3. Push your changes to your fork:
83+
```bash
84+
git push origin feature/your-feature-name
85+
```
86+
87+
4. Create a pull request from your fork to the main repository
88+
89+
## Review Process
90+
91+
- All pull requests will be reviewed by maintainers
92+
- Be prepared to make changes based on feedback
93+
- Ensure your code meets the project's standards
94+
- Address any CI/CD failures
95+
96+
## Documentation
97+
98+
- Update relevant documentation when making changes
99+
- Include examples for new features
100+
- Update the README if necessary
101+
- Add comments to complex code sections
102+
103+
## Questions?
104+
105+
If you have any questions about contributing, please:
106+
1. Check the existing documentation
107+
2. Look through existing issues
108+
3. Create a new issue if your question hasn't been answered

0 commit comments

Comments
 (0)