Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 3.49 KB

Contributing to GatewayD

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. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the GatewayD Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. That is, you transfer the all the rights to the content to the project, which will then be licensed under the project license and can be used by the project in any way deemed appropriate. We follow the Apache Contributor License Agreement, which you must agree to before your contribution can be accepted. You only need to do this once, we will inform you if your contribution requires another agreement.

Suggesting A New Proposal

We use GitHub issues to track proposals. If you have a proposal for a new feature or enhancement, follow these steps:

  • Check the list of open (and closed) Issues to see if your proposal has already been filed.
  • Open an Issue.
  • Explain the details of your proposal as clearly as possible. If you have a specific use case that would be better served by your proposal, include it.
  • Please provide as much context as possible. If you are proposing a new feature, explain why you believe it is necessary. If you are proposing changes to an existing feature, explain how your proposal improves it.

Once it's filed:

  • The project team will label the issue accordingly.
  • The team will review the proposal and provide feedback.
  • If the proposal is approved, the team will assign it to a team member to implement or leave it open for the community to implement. If you would like to implement the proposal yourself, please indicate this in the issue. The team will then assign the issue to you. You can then submit a pull request with your implementation.
  • If the proposal is rejected, the team will explain the reason for rejection and close the issue.

Attribution

This guide is based on the contributing-gen. Make your own!