Skip to content

Latest commit

 

History

History
103 lines (82 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

103 lines (82 loc) · 4.09 KB
Raw

How To Contribute

We appreciate contributions from the community to make Piper even better. To contribute, follow the steps below:

  1. Fork the Piper repository to your GitHub account.
  2. Clone the forked repository to your local machine:
git clone https://github.com/your-username/Piper.git
  1. Create a new branch to work on your feature or bug fix:
git checkout -b my-feature
  1. Make your changes, following the coding guidelines outlined in this document.
  2. Commit your changes with clear and descriptive commit messages and sign it:
git commit -s -m "fix: Add new feature"
  1. Push your changes to your forked repository:
git push origin my-feature
  1. Open a pull request against the main branch of the original Piper repository.

Pull Requests

We welcome and appreciate contributions from the community. If you have developed a new feature, improvement, or bug fix for Piper, follow these steps to submit a pull request:

  1. Make sure you have forked the Piper repository and created a new branch for your changes. Checkout How To Contribute.
  2. commit your changes and push them to your forked repository.
  3. Go to the Piper repository on GitHub.
  4. Click on the "New Pull Request" button.
  5. Select your branch and provide a descriptive title and detailed description of your changes.
  6. If your pull request relates to an open issue, reference the issue in the description using the GitHub issue syntax (e.g., Fixes #123).
  7. Submit the pull request, and our team will review your changes. We appreciate your patience during the review process and may provide feedback or request further modifications.

Pull Request Naming

The name should follow conventional commit naming.

Coding Guidelines

To maintain a consistent codebase and ensure readability, we follow a set of coding guidelines in Piper. Please adhere to the following guidelines when making changes:

  • Follow the Effective Go guide for Go code.
  • Follow the Folder convention guide for Go code.
  • Write clear and concise comments to explain the code's functionality.
  • Use meaningful variable and function names.
  • Make sure your code is properly formatted and free of syntax errors.
  • Run tests locally.
  • Check that the feature documented.
  • Add new packages only if necessary and already existing one, can't be used.
  • Add tests for new features or modification.

Helm Chart Development

To make sure that the documentation is updated use helm-docs comment convention. The pipeline will execute helm-docs command and update the version of the chart.

Also, please make sure to run those commands locally to debug the chart before merging:

make helm

Local deployment

To make it easy to develop locally, please run the following

Prerequisites :

  1. install helm
brew install helm
  1. install kubectl
brew install kubectl

  1. isntall docker

  2. install ngrok

brew install ngrok
  1. install 5
brew install kind

Deployment:

  1. make sure docker are running.
  2. create tunnel with ngrok using make ngrok, save the Forwarding address.
  3. create values.dev.yaml file that contains subset of chart's value.yaml file. check example of values file rename it to values.dev.yaml and put in root directory.
  4. use make deploy. it will do the following:
    • deploy a local registry as container
    • deploy a kind cluster as container with configuration
    • deploy nginx reverse proxy in the kind cluster
    • deploy Piper with the local helm chart
  5. validate using curl localhost/piper/healthz.

Debugging

For debugging the best practice is to use Rookout. To enable this function pass a Rookout token in the chart rookout.token or as existing secret rookout.existingSecret