Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 2.51 KB

Contributing Guidelines

First off, thank you for considering contributing to Pipelines. We're still in the early stages of development and we're excited to have you join us on this journey. If you don't already know what Pipelines is, we recommend learning more about the project by visiting our website. This will give you a better understanding of what we're trying to accomplish and build here.

The following is a set of guidelines for contributing to Pipelines. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged! :octocat:

Contents

This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate in the development of Pipelines. Following these guidelines will help ensure a positive experience for contributors and maintainers.

📖 Code of Conduct

Please review our Code of Conduct. It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting in accordance with this code is a requirement for contributing to the project.

📥 Opening an Issue

Before creating an issue, confirm that a similar issue has not already been reported. If you find a closed issue that seems to be the same as the one you're experiencing, open a new issue and link to the original issue in the body of your new one.

When creating an issue, please provide as much detail as possible. This includes:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots, if applicable
  • Any other relevant information

🔒 Reporting Security Issues

Do not file a public issue for security vulnerabilities. Instead, please email support@pipelines.lol. This will help ensure that any vulnerabilities that are found are addressed as quickly as possible. If you are not sure whether you are dealing with a security issue, please err on the side of caution, and report it via email.

TODO: Finish this document