Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.42 KB

Contributing to Unlock-TF-State-Github-Action

Thank you for considering contributing to Unlock-TF-State-Github-Action. We value your input!

Ways to Contribute

1. Reporting Issues

  • Bug Reports: If you encounter a bug or unexpected behavior, please open an issue. Include steps to reproduce and any relevant details.
  • Feature Requests: Submit suggestions for new features or improvements.

2. Pull Requests (PRs)

  • New Actions/Workflows: Feel free to propose new actions or workflows. Ensure they align with the project's goals and are well-documented.
  • Bug Fixes/Enhancements: Address existing issues or contribute enhancements by creating PRs. Provide a clear description of changes made.

How to Contribute

  1. Clone the repository to your local machine:

    git clone https://github.com/optimizely/unlock-tf-state-github-action.git
  2. Create a new branch:

    git checkout -b feature/YourFeature

    Ensure your branch name is descriptive.

  3. Make your changes and test them if applicable.

  4. Commit your changes:

    git commit -am 'Add some feature'
  5. Push to the branch:

    git push origin feature/YourFeature
  6. Create a new Pull Request (PR) against the main branch.

Code Style and Guidelines

  • Document any new actions or workflows thoroughly.
  • Ensure the changes made align with the project's scope and purpose.