Skip to content

Latest commit

 

History

History
114 lines (59 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

114 lines (59 loc) · 4.04 KB
Raw

Contributing to Firewall Orchestrator

First: if you feel insecure about how to start contributing, feel free to ask us (see contact page). You can also just go ahead with your contribution and we'll give you feedback. Don't worry - the worst that can happen is that you'll be politely asked to change something. We appreciate any contributions, and we don't want a wall of rules to stand in the way of that.

However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover what we're looking for. By addressing the points below, the chances that we can quickly merge or address your contributions will increase.

Table of contents

1. Code of conduct

2. Repo overview

3. First time contributors welcome!

4. Areas for contributing

5. Ways of contributing

6. Commit messages

7. Coding Guidelines

1. Code of conduct

Please follow our Code of conduct in the context of any contributions made to Hasura.

2. Repo overview

3. First time contributors welcome!

We appreciate first time contributors and we are happy to assist you in getting started. In case of questions, just reach out to us!

You find all issues suitable for first time contributors here.

4. Areas for contributing

Of course, we appreciate contributions to all components of Firewall Orchestrator. However, we have identified some areas that are particularly suitable for open source contributions.

Docs

Our goal is to keep our docs comprehensive and updated. If you would like to help us in doing so, we are grateful for any kind of contribution:

  • Report missing content

  • Fix errors in existing docs

  • Help us in adding to the docs

Tests

Our goal is to keep our Firewall Orchestrator stable and secure. If you would like to help us in doing so, we are grateful for any kind of contribution:

  • Write tests

  • Fix errors

5. Ways of contributing

Reporting an Issue

  • Make sure you test against the latest released version. It is possible that we may have already fixed the bug you're experiencing.

  • Provide steps to reproduce the issue

  • Please include logs of the server (/var/log/fworch/*.log), if relevant.

Working on an issue

  • We use the fork-and-branch git workflow.

  • Please make sure there is an issue associated with the work that you're doing.

  • If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.

  • Refer to an issue using fix #<issue-no> or close #<issue-no> in the commit message, at the end. For example: resolve answers to everything (fix #42) or resolve answers to everything, fix #42

  • Rebase master with your branch before submitting a pull request.

6. Commit messages

  • The first line should be a summary of the changes, not exceeding 50 characters, followed by an optional body which has more details about the changes. Refer to this link for more information on writing good commit messages.

  • Use the imperative present tense: "add/fix/change", not "added/fixed/changed" nor "adds/fixes/changes".

  • Don't capitalize the first letter of the summary line.

  • Don't add a period/dot (.) at the end of the summary line.

(Credits: Some sections are adapted from https://github.com/PostgREST/postgrest/blob/master/.github/CONTRIBUTING.md and https://github.com/hasura/graphql-engine/blob/master/CONTRIBUTING.md)

7. Coding Guidelines

Whenever contributing code, please adhere to our Coding Guidelines