Skip to content

Contributing ✨

We warmly welcome contributions to the Dynamic Notification System! Whether you’re fixing bugs, adding new features, or improving documentation, your efforts are greatly appreciated. Here’s how you can contribute effectively:

How to Contribute 🛠️

  1. Fork the Repository:

    • Click the "Fork" button at the top of this page to create your own copy of the repository.

  2. Clone Your Fork:

    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/dynamic-notification-system.git
cd dynamic-notification-system

  3. Create a New Branch:

    • Use a descriptive name for your branch: 
      git checkout -b feature/your-feature-name

  4. Make Changes:

    • Code your feature or fix a bug.
    • Follow coding standards (see below).
    • Write tests for your changes.

  5. Commit Your Changes:

    • Write clear and concise commit messages: 
      git commit -m "Add feature: your-feature-name"

  6. Push Your Changes:

    • Push your changes to your forked repository: 
      git push origin feature/your-feature-name

  7. Open a Pull Request:

    • Go to the original repository.
    • Click "New Pull Request" and provide a detailed description of your changes.

Contribution Guidelines 🔧

Coding Standards ✌️

  • Format Your Code:
    • Use gofmt to format your Go code. 
      gofmt -s -w .
  • Adhere to Go Best Practices:
  • Comment Your Code:
    • Add comments to explain complex logic and exported functions.

Documentation 📖

  • Update Documentation:
    • Ensure that your changes are reflected in the documentation.
    • Use Markdown for documentation updates.

Reporting Issues 📢

Found a bug or have a suggestion? Let us know by opening an issue:

  1. Navigate to the Issues tab.
  2. Click "New Issue."
  3. Provide a clear and detailed description of the issue.
    • Include steps to reproduce the problem if applicable.

Join the Discussion 🗨️

Collaborate with the community by participating in discussions:

  • Share ideas for new features.
  • Help review and test pull requests.
  • Engage in code reviews to ensure high-quality contributions.

Thank you for contributing to the Dynamic Notification System! Together, we can make this project even better. ❤️