Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
174 lines (116 loc) · 6.31 KB

CONTRIBUTING.md

File metadata and controls

174 lines (116 loc) · 6.31 KB

Contributing Guidelines

Thank you for your interest in contributing to Stickler! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Quick Start for Contributors

Prerequisites

  • Python 3.12+
  • conda (recommended) or venv
  • Git

Setup

# Clone and setup
git clone https://github.com/awslabs/stickler.git
cd stickler
conda create -n stickler python=3.12 -y
conda activate stickler
pip install -e ".[dev]"

# Verify installation
pytest tests/ -v --tb=short

Development Workflow

  1. Create a branch from dev: git checkout -b feature/your-feature dev
  2. Make your changes
  3. Run tests: pytest tests/
  4. Run linting: ruff check .
  5. Commit with conventional format: feat: add new feature
  6. Submit PR to dev branch

Detailed Guides

For comprehensive documentation, see:

Guide Description
Development Setup Full environment configuration
Testing Guide Test patterns and best practices
Code Style Naming conventions and linting
Pull Request Guide Branch workflow and PR process

Quick Reference

Common Commands

Task Command
Run all tests pytest tests/
Run with coverage coverage run -m pytest tests/ && coverage report
Run specific tests pytest tests/ -k "pattern"
Lint check ruff check .
Lint fix ruff check --fix .

Commit Message Format

type: brief description

Types: feat, fix, docs, style, refactor, test, chore

Documentation Contributions

Documentation is built with MkDocs and lives in the docs/ directory.

# Setup and serve docs locally
cd docs
make install  # Install dependencies
make docs     # Start dev server at http://127.0.0.1:8000

When contributing documentation:

  • Edit Markdown files in docs/docs/
  • Follow existing structure and style
  • Test locally with make docs before submitting PR
  • Documentation PRs should also target dev branch

See the Building Documentation section for detailed information.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the dev branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

Pull Request Process

To send us a pull request, please:

  1. Fork the repository.
  2. Create a feature branch from the dev branch (not main).
  3. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  4. Ensure local tests pass.
  5. Commit to your fork using clear commit messages.
  6. Submit your pull request to the dev branch (not main).
  7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

Pull Request Template

When creating a pull request, please use the following template to ensure all necessary information is included:

*Issue #, if available:*

*Description of changes:*


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Branch Guidelines

  • All pull requests must target the dev branch
  • The main branch is reserved for stable releases
  • Use descriptive branch names (e.g., feature/add-new-validator, bugfix/fix-memory-leak)
  • Keep your branch up to date with the latest dev branch before submitting

Commit Message Guidelines

  • Use clear and meaningful commit messages
  • Follow the format: type: brief description
  • Types: feat, fix, docs, style, refactor, test, chore
  • Example: feat: add new data validation algorithm

Refer to this guide for clear commit guidelines

GitHub provides additional document on forking a repository and creating a pull request.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.