Skip to main content

Contributing to Premail

Thank you for taking the time to contribute!

Premail is open-source, and contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated!

When contributing, especially for the first time, consider starting by creating an issue so you can get feedback from the maintainers and avoid unncessary work.

Note: Premail has a code of conduct. Please follow it in all your interactions with the project.

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a single bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.

  2. Fork the project on GitHub.

  3. Create your feature branch:

    git checkout -b feat/amazing_feature
  4. Do your work. Read the Premail development guide.

  5. Commit your changes:

    git commit -m 'feat: add amazing_feature'
  6. Push to the branch:

    git push origin feat/amazing_feature
  7. Open a Pull Request and wait for feedback.

🎉 Thank you for your contribution!