Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Latest commit

 

History

History
84 lines (61 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

84 lines (61 loc) · 3.54 KB
Raw

Contributing Guidelines

This document contains information and guidelines about contributing to this project. Please read it before you start participating.

Topics

Asking Questions

You can send us an email at hey@whispeer.me

Reporting Security Issues

We take security seriously. If you discover a security issue, please bring it to our attention right away!

Please DO NOT file a public issue, instead send your report privately to us via email. This will help ensure that any vulnerabilities that are found can be disclosed responsibly to any affected parties.

Reporting Other Issues

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.

Check that the project issues database doesn't already include that problem or suggestion before submitting an issue. If you find a match, add a quick "+1" or "I have this problem too." Doing this helps prioritize the most common problems and requests.

When reporting issues, please include the following:

  • The version of Node.js you're using
  • The version of PostgreSQL, if relevant
  • Detailed steps to reproduce the issue
  • The full output of any server logs, errors, or stack traces
  • A code snippet or a link to a repository that reproduces the described behavior, if applicable
  • Information about the HTTP request that triggered the issue, including request method, headers, and body, if applicable
  • Details about any related environment variables or configuration settings
  • Any other details that would be useful in understanding the problem, such as network configurations or specific interactions with other services

This information will help us review and fix your issue faster.

Opening Pull Requests

We respect the contributors' labor more than anything, so, we would like to confirm your contributions are made by the true person through your public GPG Key that validates your full name and email address.

Pull Requests will be merged only after they are signed with valid GPG signatures from the author.

Developer Certificate of Origin

Version 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.