Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 3 KB

Contributing to Open-Temp-Mail

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Open-Temp-Mail Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [INSERT CONTACT METHOD].

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

I Want To Contribute

Reporting Bugs

This section guides you through submitting a bug report for Open-Temp-Mail. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps to reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Open-Temp-Mail, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Your First Code Contribution

  1. Fork the repository on GitHub.
  2. Clone your fork locally. 
    git clone https://github.com/your-username/open-temp-mail.git
cd open-temp-mail
  3. Create a new branch for your feature or fix. 
    git checkout -b feature/my-new-feature
  4. Make your changes and commit them. 
    git commit -m "Add some feature"
  5. Push to your fork. 
    git push origin feature/my-new-feature
  6. Open a Pull Request on GitHub.

Styleguides

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