Skip to content

Repository navigation

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (57 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 2.36 KB
Raw

Contributing

Thank you for considering contributing to this project! This document outlines the process and guidelines.

Quick Start

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/github-actions-templates.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes and commit with clear messages
  5. Push to your fork: git push origin feature/your-feature-name
  6. Open a Pull Request with a clear description

Development Setup

# Clone the repository
git clone https://github.com/donny-devops/github-actions-templates.git
cd github-actions-templates

# Install dependencies (see README for specifics)
# Example for Python projects:
# pip install -e ".[dev]"

# Run tests
# See README.md for project-specific test commands

Coding Standards

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages
  • Add tests for new features
  • Update documentation as needed
  • Ensure all tests pass before submitting

Pull Request Guidelines

Before Submitting

  • Tests pass locally
  • Code follows project style guidelines
  • Documentation updated (if applicable)
  • Commit messages are clear and descriptive
  • Branch is up to date with main

PR Description Should Include

  • What changed and why
  • How to test the changes
  • Related issues (if any) - use Fixes #123 or Closes #456
  • Breaking changes (if any)

Code Review Process

  1. A maintainer will review your PR within 3-5 business days
  2. Address any requested changes
  3. Once approved, a maintainer will merge your PR

Reporting Issues

  • Use the issue templates when available
  • Provide clear steps to reproduce
  • Include relevant logs, screenshots, or error messages
  • Specify your environment (OS, version, dependencies)

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.

Questions?

  • Open an issue with the question label
  • Check existing issues and pull requests first
  • See SUPPORT.md for additional help resources

License

By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE).

Thank you for helping make this project better! 🚀