Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (85 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

101 lines (85 loc) · 3.48 KB
Raw

Contributing to XMLValidator

Thank you for considering contributing to this project! We welcome all contributions, whether it's bug reports, new features, documentation improvements, or anything else that enhances the project.

For general project info, setup instructions, and usage examples, see the README.

How to Contribute

1. Reporting Issues

  • If you find a bug or have a feature request, open a GitHub Issue.
  • Provide clear and detailed information, including steps to reproduce the issue (if applicable).
  • Suggest a possible fix or enhancement if you have one.

2. Submitting Code Changes

Step 1: Fork, clone & branch

  • If you are an external contributor, fork this repository first.
  • Clone your fork: 
    git clone https://github.com/<your-github-username>/robotframework-xmlvalidator.git
  • Navigate into the directory: 
    cd robotframework-xmlvalidator
  • If you have maintainer write access, you may instead clone the canonical repository directly: 
    git clone https://github.com/MichaelHallik/robotframework-xmlvalidator.git
cd robotframework-xmlvalidator
  • Create a new branch for your feature/fix: 
    git switch -c feature/schema-validation
    Use clear, descriptive branch names. Suggested prefixes:
    • feature/<short-description> for new features
    • fix/<issue-id> for bug fixes
    • docs/<section> for documentation updates
    • chore/<task> for maintenance or config changes

Step 2: Code & Test

  • Follow the existing code structure and style.
  • Ensure your code is well-documented.
  • Run linting, formatting and typing checks before committing: 
    poetry run pylint src
poetry run black src --check
poetry run pyright --project pyrightconfig.json
  • Make sure all unit tests pass before committing: 
    poetry run python -m pytest test/unit
    See test/_doc/unit/README.md for details.
  • Make sure all integration tests pass before committing: 
    poetry run python -m robot --outputdir results test/integration
    See test/_doc/integration/README.md for details.

Step 3: Commit & Push

  • Commit your changes with a meaningful message: 
    git commit -m "Add feature XYZ."
  • Push the branch to your fork, or to the canonical repository if you are a maintainer: 
    git push -u origin feature/schema-validation

Step 4: Open a Pull Request (PR)

  • If you had not done so earlier, test, lint and document (see step 2).
  • Update or add documentation as needed.
  • Add an entry to CHANGELOG.md summarizing your change (under "Unreleased").

Then:

  • Open a PR against the main branch.
  • This will trigger GitHub Actions to run linting and tests.
  • Ensure all CI/CD checks pass, before requesting a review.
  • Address any requested changes.
  • Wait for approval & merge.

3. Code Style Guidelines

  • Follow PEP 8 for Python code.
  • Keep modules, methods/functions, and classes well-documented.

4. Testing

  • All new functionality should include tests.
  • Run both unit tests (pytest) and Robot Framework integration tests.

5. Community Guidelines

  • Be respectful and constructive.
  • Follow the Code of Conduct.
  • Help improve documentation when possible.

Thank you for your contributions!

Makefile

The Makefile in this repository provides a simplified command-line interface for common development tasks such as linting and testing.

See make help for available Make targets.