Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 3.58 KB
Raw

Contributing Guidelines

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

Topics

Reporting Security Issues

Please DO NOT file a public issue, instead send your report privately to ezequiel.aceto+regraphql@gmail.com.org. 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, feel free to vote for the issue by adding a reaction. Doing this helps prioritize the most common problems and requests.

When reporting issues, please fill out our issue template. The information the template asks for will help us review and fix your issue faster.

Submitting Pull Requests

You can contribute by fixing bugs or adding new features. For larger code changes, we first recommend discussing them in our Github issues. When submitting a pull request, please add relevant tests and ensure your changes don't break any existing tests (see Automated Tests below).

Automated Tests

ReGraphQL's tests depend on go test. To run the automated tests, you first need to have Go version 1.18.

In your terminal, run the following commands:

go test ./...

Developer's Certificate of Origin

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.

Code of Conduct

The Code of Conduct governs how we behave in public or in private whenever the project will be judged by our actions. We expect it to be honored by everyone who contributes to this project.

See CONDUCT.md for details.

Some of the ideas and wording for the statements above were based on work by the Docker and Linux communities. We commend them for their efforts to facilitate collaboration in their projects.