Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (30 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 2.33 KB

Contributing to FreeCustom.Email

First off, thank you for considering contributing to FreeCustom.Email! It's people like you that make FreeCustom.Email such a great tool.

Where to Start?

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into FreeCustom.Email itself.

Code of Conduct

This project and everyone participating in it is governed by the FreeCustom.Email Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to dishantsinghdev@icloud.com.

How to Contribute

Reporting Bugs

Bugs are tracked as GitHub issues. Before opening a new issue, please check if the bug has already been reported. If it has, please add a comment to the existing issue instead of opening a new one.

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Before opening a new issue, please check if the enhancement has already been suggested. If it has, please add a comment to the existing issue instead of opening a new one.

Pull Requests

We love pull requests! Here's a quick guide:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Code Style

We use Prettier and ESLint to maintain a consistent code style. Please run npm run lint and npm run format before submitting a pull request.

License

By contributing, you agree that your contributions will be licensed under its Apache License 2.0.