Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (61 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

103 lines (61 loc) · 2.29 KB

Contributing to Notifications Module

Welcome! We're excited that you're interested in contributing to Notifications Module. Your contributions help make this project better for everyone.

Please take a moment to review this document to ensure your contribution process is smooth and effective.

🧰 Prerequisites

Before contributing, make sure you:

  • Have Git installed.

  • Can run the project locally.

  • Are familiar with Android development basics (if contributing to code).

🛠️ How to Contribute

1. Fork the Repository

Click the Fork button on the top right to create your own copy of the project.

2. Clone Your Fork

git clone https://github.com/your-username/Notifications-Module.git

Replace your-username with your actual GitHub username.

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

Make your edits in the appropriate files. Follow the code style and naming conventions used in the project.

5. Commit Your Changes

git add .
git commit -m "Add: Your meaningful commit message"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Submit a Pull Request

Open a pull request (PR) to the dev branch (unless you are fixing something critical in main). Describe your changes clearly in the PR description.

✅ Code of Conduct

We expect all contributors to abide by our Code of Conduct to create a welcoming and respectful environment.

✨ Types of Contributions

You can contribute in many ways:

  • 🚀 Feature development

  • 🐛 Bug fixes

  • 📝 Documentation improvements

  • 🎨 UI/UX suggestions

  • ✅ Code optimization

💡 Tips for a Good Contribution

  • Keep PRs focused and small.

  • Use clear and concise commit messages.

  • Test your code before submitting.

  • Feel free to open an issue before starting major changes.

🙌 Need Help?

If you have questions, open an issue or reach out via lakshayjainfzr@gmail.com

Thank you for your interest in contributing! 💖