Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 6.06 KB

CONTRIBUTING.md

File metadata and controls

169 lines (124 loc) · 6.06 KB
Raw

Want to contribute?

Great! We welcome contributions of all kinds, big or small! This includes bug reports, code fixes, documentation improvements, and code examples.

Before you dive in, please take a moment to read through this guide.

Reporting issue

We use GitHub to manage the issues. Please open a new issue directly there.

Getting Started

Setting Up Your Environment

  • Head over to GitHub and fork the 5GSec SentryFlow repository.
  • Clone your forked repository onto your local machine. 
    git clone [email protected]:<your-username>/SentryFlow.git

Install development tools

You'll need these tools for a smooth development experience:

Contributing Code

Building Locally

  • Install development tools as mentioned above.

  • Build SentryFlow using:

    cd sentryflow
make build

Understanding the Project

Before contributing to any Open Source project, it's important to have basic understanding of what the project is about. It is advised to try out the project as an end user.

Project Structure

These are general guidelines on how to organize source code in this repository.

github.com/5GSEC/SentryFlow

├── client                                    -> Log client code.
├── deployments                               -> Manifests or Helm charts for deployment on Kubernetes.
├── docs                                      -> All Documentation.
│   └── receivers                                 -> Receiver specifc integration documentaion.
│       ├── other 
│       │   ├── ingress-controller
│       │   │   └── nginx-inc
│       │   └── web-server
│       │       └── nginx
│       └── service-mesh
│           └── istio
├── filter                                    -> Receivers specific filters/modules to observe API calls from receivers.
├── protobuf
│   ├── golang                                -> Generated protobuf Go code.
│   ├── python                                -> Generated protobuf Python code.
├── scripts
├── sentryflow
│   ├── cmd                                   -> Code for the actual binary.
│   ├── config
│   │   └── default.yaml                     -> Default configuration file.
│   ├── go.mod                               -> Go module file to track dependencies.
│   └── pkg                                  -> pkg is a collection of utility packages used by the components without being specific to its internals.
│       ├── config                           -> Configuration initialization code.
│       ├── core                             -> SentryFlow core initialization code.
│       ├── exporter                         -> Exporter code.
│       ├── k8s                              -> Kubernetes client code.
│       ├── receiver                         -> Receiver code.
│       │   ├── receiver.go                     -> All receivers initialization code.
│       │   └── svcmesh                         -> ServiceMesh receivers code.
│       │   └── other                           -> Other receivers code.
│       └── util                            -> Utilities.

Imports grouping

This project follows the following pattern for grouping imports in Go files:

  • imports from standard library.
  • imports from other projects.
  • imports from sentryflow project.

For example:

import (
  "context"
  "fmt"
  
  "k8s.io/apimachinery/pkg/runtime"
  "sigs.k8s.io/controller-runtime/pkg/client"
  
  "github.com/5GSEC/SentryFlow/pkg/config"
  "github.com/5GSEC/SentryFlow/pkg/receiver"
  "github.com/5GSEC/SentryFlow/pkg/util"
)

Pull Requests and Code Reviews

We use GitHub pull requests for code contributions. All submissions, including those from project members, require review before merging. We typically aim for two approvals per pull request, with reviews happening within a week or two. Feel free to ping reviewers if you haven't received feedback within that timeframe.

Commit Messages

We follow the Conventional Commits specification for clear and consistent commit messages.

Please make sure you have added the Signed-off-by: footer in your git commit. In order to do it automatically, use the --signoff flag:

git commit --signoff

With this command, git would automatically add a footer by reading your name and email from your .gitconfig file.

Merging PRs

For maintainers: Before merging a PR make sure the title is descriptive and follows a good commit message.

Merge the PR by using Squash and merge option on GitHub. Avoid creating merge commits. After the merge make sure referenced issues were closed.

Testing and Documentation

Tests and documentation are not optional, make sure your pull requests include:

  • Tests that verify your changes and don't break existing functionality.
  • Updated documentation reflecting your code changes.
  • Reference information and any other relevant details.

Commands to run tests

  • Unit tests:

    make tests

  • Integration tests:

    make integration-test

  • End-to-end tests:

    make e2e-test