Skip to content
This repository has been archived by the owner on Aug 21, 2022. It is now read-only.

Latest commit

 

History

History
39 lines (24 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.34 KB

Contributing Guidelines

Thank you for contributing to the epispot repository! Here are some guidelines to streamline all contributions so we can accept issues and/or pull requests as fast as possible.

Important Note:

If you are working on a documentation patch, please see DOCUMENTATION.md for more information. For security patches, see SECURITY.md.

Issues

I found a bug.

When creating an issue, you will be prompted to choose a template. Choose BUG_REPORT and fill in the required information before submitting the issue.

I have a feature request.

When creating the issue, you will also be prompted to choose a template. Choose FEATURE_REQUEST and fill out the template with any information that you have.

I found a security vulnerability.

Check out the steps outlined in SECURITY.md and submit the issue after verifying that the vulnerability still exists on a supported version.

Neither.

Create a blank issue and include as much information as possible about the problem you're facing. If this is a usage problem, consider opening a discussion rather than an issue.

Pull Requests

Regardless of the type of PR you're submitting, first make sure to do the following:

  1. Fork the repo

  2. Clone your fork

  3. Run the build script:

    bash scripts/build.sh