Contributing

Thank you for your interest in MailCade!

#Current Status

MailCade is currently not accepting code contributions.

The project is in its early stages and the codebase is being actively developed by the core team. We want to establish a solid foundation before opening up to external contributions.

#How You Can Help

While we're not accepting code contributions yet, you can still help:

#🐛 Report Bugs

Found a bug? Please report it!

  1. Check existing issues first
  2. If it's new, create an issue
  3. Include:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Your OS and MailCade version
    • Screenshots (if applicable)

#💡 Suggest Features

Have an idea? We'd love to hear it!

  1. Check existing feature requests
  2. If it's new, open a feature request
  3. Describe:
    • What problem it solves
    • How it would work
    • Why it would be useful

#⭐ Star the Repository

Show your support by starring the repo on GitHub: https://github.com/olakunlevpn/MailCade

#📢 Spread the Word

Help others discover MailCade:

  • Share it with your developer friends
  • Tweet about it
  • Write a blog post
  • Mention it in your projects

#Bug Report Template

When reporting bugs, include:

Describe the bug
A clear description of what's wrong.

To Reproduce
Steps to reproduce:

  1. Go to '...'
  2. Click on '...'
  3. See error

Expected behavior
What should happen instead.

Environment:

  • OS: [e.g. macOS 13.0]
  • MailCade Version: [e.g. 1.0.0]

Screenshots
If applicable, add screenshots.

Additional context
Logs, error messages, etc.

#Feature Request Template

When suggesting features, include:

Problem
What problem does this solve?

Proposed solution
Describe your ideal solution.

Alternatives considered
Other approaches you've thought about.

Additional context
Mockups, examples, use cases.

#Future Contributions

We plan to open contributions in the future. When we do, we'll update this guide with:

  • Coding standards
  • Development setup
  • Pull request process
  • Code review guidelines

Stay tuned by watching the repository!

#Community Guidelines

When interacting on GitHub:

  • ✅ Be respectful and inclusive
  • ✅ Provide constructive feedback
  • ✅ Help others when you can
  • ❌ No harassment or discrimination
  • ❌ No spam or off-topic comments

#Questions?

Have questions about MailCade?

#License

MailCade is licensed under the MIT License. See the LICENSE file for details.


Thank you for your interest in MailCade! We appreciate your support! 🎉