Skip to content

Latest commit

 

History

History
96 lines (71 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

96 lines (71 loc) · 3.64 KB
Raw

Contributing to Warestack Workflow Copilot Action

Thank you for considering contributing to the Warestack Workflow Copilot Action! This repository focuses on automating log analysis, error identification, and patch suggestion within GitHub workflows. Whether you're improving the action, fixing bugs, or enhancing documentation, your contributions are highly valued.

Types of Contributions

We welcome various types of contributions, including:

  • Enhancements to the log analysis and patch generation algorithms.
  • Updates to existing functionalities to cover more scenarios or provide more stability.
  • Documentation improvements to clarify usage and setup.
  • Bug fixes related to action execution or result handling.
  • Typo and grammar corrections in the documentation.

How to Contribute

To ensure a smooth contribution process, please follow these steps:

  1. Fork the Repository: Fork the repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine.
  3. Create a New Branch: Branch off from the main branch using a descriptive name for your changes.
  4. Make Changes: Implement your changes, adhering to the coding standards and architectural patterns used in the project.
  5. Commit Changes: Commit your changes using clear, concise commit messages that follow the guidelines below.
  6. Push Changes: Push your changes to your fork on GitHub.
  7. Open a Pull Request: Submit a pull request from your fork back to the original repository. Describe your changes and their impact.

Guidelines

  • Code Quality: Contributions should be well-written and maintainable. Ensure your code is clean and well-documented.
  • Testing: Test your changes thoroughly to ensure they work as expected and do not negatively impact existing functionalities.
  • Modular PRs: Keep your pull requests focused and modular to facilitate easier review and integration.
  • Review Process: All pull requests require at least one review from the maintainers before merging.

Branch Naming Conventions

Use the following prefixes for branch names to indicate the purpose of the changes:

  • feature/: New features or enhancements.
  • bugfix/: Bug fixes.
  • docs/: Documentation updates.
  • refactor/: Refactoring existing code.
  • test/: Adding or updating tests.
  • chore/: Routine tasks such as dependency updates.

Commit Message Guidelines

  • Present Tense: Write commit messages in present tense ("Add feature" not "Added feature").
  • Imperative Mood: Write in imperative mood ("Change code" not "Changes in code").
  • Descriptive: Clearly describe the changes made, why they were necessary, and their impact.

Examples:

  • Add error parsing logic to enhance detection
  • Fix memory leak in log processing
  • Update README to include setup instructions

Automated Checks

We use GitHub Actions to automatically check all pull requests:

  • Linting: Ensures code style consistency.
  • Unit Tests: Validates that new changes pass all existing and new tests.
  • Integration Tests: Checks that the action works as expected in an integrated environment.

Getting Help

If you have questions or need assistance, please reach out through:

  • GitHub Issues for detailed discussions or to report a problem.
  • Our Discord channel for live discussions and community support.

Code of Conduct

Participation in this project is governed by a Code of Conduct. By participating, you are expected to uphold this code and ensure a respectful and constructive environment for everyone.

Thank you for contributing to the Warestack Workflow Copilot Action!