Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 2.5 KB

Contributing.md

File metadata and controls

82 lines (58 loc) · 2.5 KB

Contributing to Akeyless GitHub Actions Plugin

We warmly welcome contributions to the Akeyless GitHub Actions Plugin! Whether it's fixing bugs, adding new features, or improving documentation, every contribution is valuable and appreciated.

Getting Started

1. Fork and Clone the Repository

Fork this repository on GitHub and clone your fork locally.

git clone https://github.com/akeyless-community/akeyless-github-action.git
cd akeyless-github-action

2. Install Dependencies

Before you start, install the necessary dependencies:

npm install

3. Create a New Branch

Create a branch for your work to keep it separate from the main codebase.

git checkout -b my-feature-branch

Making Changes

1. Before Adding Akeyless GitHub Action

Ensure you're familiar with the inputs, outputs, and the setup requirements for different authentication methods as detailed in the README.

2. Coding Guidelines

  • Keep your changes focused and limited to a single feature or fix.
  • Write clear, understandable code.
  • Add comments where necessary.

3. Testing Your Changes

Add or update tests to cover your changes. Ensure all tests pass before submitting your code.

npm run test

4. Build the Project

Update dist/index.js using the build command to ensure the project is properly compiled.

npm run package

Submitting Your Changes

1. Push Your Changes

Push your changes to your fork on GitHub.

git push origin my-feature-branch

2. Create a Pull Request

Open a pull request from your feature branch to the main repository. Describe your changes and their impact.

3. Wait for Review

Your pull request will be reviewed by the Akeyless team. Engage in discussions and make any necessary updates based on feedback.

Increase the Chance of Acceptance

  • Ensure you write tests for your code.
  • Keep your changes as focused as possible. Submit unrelated changes as separate pull requests.
  • Adhere to the coding and documentation style of the project.

Resources

Thank you for your interest in contributing to the Akeyless GitHub Actions Plugin. Your contributions help us build a more robust and feature-rich tool.

❤️ The Akeyless Team