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

Latest commit

 

History

History
53 lines (28 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

53 lines (28 loc) · 2.79 KB
Raw

Contributing Guidelines

Welcome, and thanks in advance for your help! Please follow these simple guidelines 👍

Propose a New Feature or Bug Fix

Note: Please make sure to write an issue first and get enough feedback before jumping into a Pull Request!

  • Please make sure there is an open issue discussing your contribution.
  • If there isn't, open an issue so we can talk about it before you invest time into the implementation.
  • When creating an issue follow the guide that GitHub shows so we have enough information about your proposal.

Working on an Existing Issue

Note: Please write a quick comment in the corresponding issue and ask if the feature is still relevant and that you want to jump into the implementation.

Check out our help-wanted or easy-pick labels to find issues we want to move forward on with your help.

We will do our best to respond/review/merge your PR according to priority. We hope that you stay engaged with us during this period to insure QA. Please note that the PR will be closed if there hasn't been any activity for a long time (~ 30 days) to keep us focused and keep the repo clean.

Reviewing Pull Requests

Another really useful way to contribute to the Event Gateway is to review other peoples Pull Requests. Having feedback from multiple people is really helpful and reduces the overall time to make a final decision about the Pull Request.

Writing / Improving Documentation

Our documentation lives on GitHub in the docs directory. Do you see a typo or other ways to improve it? Feel free to edit it and submit a Pull Request!

Providing Support

The easiest thing you can do to help us move forward and make an impact on our progress is to simply provide support to other people having difficulties with their Serverless projects.

You can do that by replying to issues on Github, chatting with other community members in our Chat or helping with questions in our Forum.

Code Style

We use gofmt. Please format Golang files with this tool before submitting a PR.

Testing

We aim for high test coverage, so make sure your tests cover as much of your code as possible.

Our Code of Conduct

Finally, to make sure you have a pleasant experience while being in our welcoming community, please read our code of conduct. It outlines our core values and believes and will make working together a happier experience.

Thanks again for being a contributor to the Serverless Community 🎉!

Cheers,

The ⚡ Serverless Team