You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
4.3 KiB
Markdown
76 lines
4.3 KiB
Markdown
# 🚀 Contributing to go-zero
|
|
|
|
Welcome to the go-zero community! We're thrilled to have you here. Contributing to our project is a fantastic way to be a part of the go-zero journey. Let's make this guide exciting and fun!
|
|
|
|
## 📜 Before You Dive In
|
|
|
|
### 🤝 Code of Conduct
|
|
|
|
Let's start on the right foot. Please take a moment to read and embrace our [Code of Conduct](/code-of-conduct.md). We're all about creating a welcoming and respectful environment.
|
|
|
|
### 🌟 Community Expectations
|
|
|
|
At go-zero, we're like a close-knit family, and we believe in creating a healthy, friendly, and productive atmosphere. It's all about sharing knowledge and building amazing things together.
|
|
|
|
## 🚀 Getting Started
|
|
|
|
Get your adventure rolling! Here's how to begin:
|
|
|
|
1. 🍴 **Fork the Repository**: Head over to the GitHub repository and fork it to your own space.
|
|
|
|
2. 🛠️ **Make Your Magic**: Work your magic in your forked repository. Create new features, squash bugs, or improve documentation - it's your world to conquer!
|
|
|
|
3. 🚀 **Submit a PR (Pull Request)**: When you're ready to unveil your creation, submit a Pull Request. We can't wait to see your awesome work!
|
|
|
|
## 🌟 Your First Contribution
|
|
|
|
We're here to guide you on your quest to become a go-zero contributor. Whether you want to file issues, develop features, or tame some critical bugs, we've got you covered.
|
|
|
|
If you have questions or need guidance at any stage, don't hesitate to [open an issue](https://github.com/zeromicro/go-zero/issues/new/choose).
|
|
|
|
## 🔍 Find Something to Work On
|
|
|
|
Ready to dive into the action? There are several ways to contribute:
|
|
|
|
### 💼 Find a Good First Topic
|
|
|
|
Discover easy-entry issues labeled as [help wanted](https://github.com/zeromicro/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or [good first issue](https://github.com/zeromicro/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). These issues are perfect for newcomers and don't require deep knowledge of the system. We're here to assist you with these tasks.
|
|
|
|
### 🪄 Work on an Issue
|
|
|
|
Once you've picked an issue that excites you, let us know by commenting on it. Our maintainers will assign it to you, and you can embark on your mission!
|
|
|
|
### 📢 File an Issue
|
|
|
|
Reporting an issue is just as valuable as code contributions. If you discover a problem, don't hesitate to [open an issue](https://github.com/zeromicro/go-zero/issues/new/choose). Be sure to follow our guidelines when submitting an issue.
|
|
|
|
## 🎯 Contributor Workflow
|
|
|
|
Here's a rough guide to your contributor journey:
|
|
|
|
1. 🌱 Create a New Branch: Start by creating a topic branch, usually based on the 'master' branch. This is where your contribution will grow.
|
|
|
|
2. 💡 Make Commits: Commit your work in logical units. Each commit should tell a story.
|
|
|
|
3. 🚀 Push Changes: Push the changes in your topic branch to your personal fork of the repository.
|
|
|
|
4. 📦 Submit a Pull Request: When your creation is complete, submit a Pull Request to the [go-zero repository](https://github.com/zeromicro/go-zero).
|
|
|
|
## 🌠 Creating Pull Requests
|
|
|
|
Pull Requests (PRs) are your way of making a grand entrance with your contribution. Here's how to do it:
|
|
|
|
- 💼 Format Your Code: Ensure your code is beautifully formatted with `gofmt`.
|
|
- 🏃 Run Tests: Verify that your changes pass all the tests, including data race tests. Run `go test -race ./...` for the ultimate validation.
|
|
|
|
## 👁️🗨️ Code Review
|
|
|
|
Getting your PR reviewed is the final step before your contribution becomes part of go-zero's magical world. To make the process smooth, keep these things in mind:
|
|
|
|
- 🧙♀️ Follow Good Coding Practices: Stick to [good coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
|
|
- 📝 Write Awesome Commit Messages: Craft [impressive commit messages](https://chris.beams.io/posts/git-commit/) - they're like spells in the wizard's book!
|
|
- 🔍 Break It Down: For larger changes, consider breaking them into a series of smaller, logical patches. Each patch should make an understandable and meaningful improvement.
|
|
|
|
Congratulations on your contribution journey! We're thrilled to have you as part of our go-zero community. Let's make amazing things together! 🌟
|
|
|
|
Now, go out there and start your adventure! If you have any more magical ideas to enhance this guide, please share them. 🔥 |