93 lines (58 loc) · 1.42 KB

Contributing to GoEnum

Thank you for considering contributing to GoEnum! 🎉
This guide will help you get started.

🧑‍💻 How to Contribute

We welcome:

🐛 Bug reports
🌟 Feature suggestions
💡 Code improvements
📚 Documentation fixes
✅ Tests or examples

🛠️ Setup Instructions

Fork the repo and clone your fork:

   git clone https://github.com/YOUR_USERNAME/GoEnum.git
   cd GoEnum

Install dependencies:
```
go mod tidy
```
Run tests:
```
go test ./...
```

🔁 Making Changes

Create a branch:

git checkout -b feature/your-feature-name

Make your changes and write tests if needed.
Run tests before committing:
```
go test ./...
```

Commit and push:

git commit -m "feat: add new feature"
git push origin feature/your-feature-name

Open a Pull Request to the main branch.

🧹 Code Style & Rules

Use gofmt to format your code:
```
go fmt ./...
```
Keep pull requests focused and atomic.
Write clear and concise commit messages.

🤝 Code of Conduct

Please follow our Code of Conduct in all interactions.

🙋 Questions?

If you're unsure or want to discuss something, feel free to open an issue or start a discussion.

Thank you for helping make GoEnum better! 💚