Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 2.9 KB
Raw

Contributing

Introduction

Contribution is welcome!

This project adheres to the Code of Conduct. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Reporting issues

Please, report any issues or bugs you find in the project's Issues section on GitHub.

Contributing to code

Workflow for local development

  1. Fork the repo.
  2. Clone the forked repo to your local machine.
  3. Create a new branch for your changes: git checkout -b "feat/my-new-feature".
  4. Make your changes. We recommend using VSCode + Docker locally.
  5. Commit your changes: git commit -m "feat: my new feature".
  6. Push your changes to your forked repo: git push origin feat/my-new-feature.
  7. Create a pull request from your forked repo to the main repo.

Workflow for GitHub Codespaces in-browser development

  1. Fork the repo.
  2. Open Codespaces by clicking the green button Code on the top right corner of the repo and then Open with Codespaces. GitHub Codespaces will create and open a full-featured dev environment in the browser. You don't need to install anything locally.
  3. Create a new branch for your changes: git checkout -b "feat/my-new-feature"
  4. Make your changes.
  5. Commit your changes: git commit -m "feat: my new feature"
  6. Push your changes to your forked repo: git push origin feat/my-new-feature
  7. Create a pull request from your forked repo to the main repo.

About using VSCode

The recommended way for local development is to use VSCode + Docker Desktop.

VSCode supports .devcontainer configuration that will automatically build a full-featured dev environment for you. All plugins and hooks are already configured for you.

git clone git@github.com:syngenta/k8s-deploy.git
cd k8s-deploy

code .