Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

74 lines (58 loc) · 2.26 KB

Contributing to Dynamic Notification System

We’re thrilled that you’re interested in contributing to the Dynamic Notification System! 🎉 Your help is essential for improving the project and making it more useful for the community. 🚀

How to Contribute

1. Fork and Clone the Repository 🍴

  • Fork this repository to your GitHub account.
  • Clone your fork locally: 
    git clone https://github.com/zrougamed/dynamic-notification-system.git

2. Set Up Your Development Environment 🛠️

  • Ensure you have Go 1.23+ installed.
  • Install required dependencies: 
    go mod tidy

3. Explore Open Issues 🐛

4. Work on Your Changes ✍️

  • Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  • Make your changes and commit them: 
    git add .
git commit -m "Add your feature description here"
  • Ensure your code is formatted and linted properly. 
    go fmt ./...
go vet ./...

5. Submit a Pull Request 🔀

  • Push your branch to your fork: 
    git push origin feature/your-feature-name
  • Open a pull request to the main repository.
  • Add a descriptive title and comment explaining your changes.

Contribution Guidelines 📜

Code Style 🖊️

  • Follow standard Go best practices.
  • Write meaningful commit messages.
  • Ensure your code is clean, readable, and well-documented.

Documentation 📘

  • Update the README or other relevant documentation if your changes introduce new features or updates.

Reporting Bugs 🐞

  • Open a new issue and provide the following details:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Your environment details.

Requesting Features 🌟

  • Open an issue and describe the feature you’d like to see.
  • Explain why it’s needed and how it can benefit users.

Code of Conduct 🤝

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.

Thank you for contributing! 🎉 Your efforts make a difference! 💪