Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (31 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

40 lines (31 loc) · 1.21 KB

Contributing to Web Lifter Projects

Thanks for your interest in contributing. This guide applies to all repositories under the web-lifter organization.

Please read and follow our Code of Conduct in CODE_OF_CONDUCT.md before participating.

Reporting Bugs

Open a GitHub Issue in the relevant repository and include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Error logs or screenshots when helpful

Suggesting Features

Open a GitHub Issue with:

  • The use case and impact
  • A proposed solution or approach

Submitting Pull Requests

  1. Fork the repository and create a branch from main.
  2. Develop your changes following the code standards below.
  3. Test locally and document any limitations.
  4. Open a PR with a clear description and link related issues.

Code Standards

  • Clear variable naming
  • Error handling for external calls
  • Comments for non-obvious logic
  • Follow existing patterns in the repository

PR Requirements

  • Descriptive title
  • Linked issue where applicable
  • Tested locally
  • Follows existing patterns

Review Process

Maintainers review PRs as time allows and may request changes.

License

By contributing, you agree your contributions are licensed under the repository's license.