Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
153 lines (94 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

153 lines (94 loc) · 4.25 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Guidelines for AI-assisted Contributions

AI tools are welcome as helpers, not authors. Keep these practices in mind:

  • Stay accountable: only submit changes you understand and can justify; be ready to explain behavior, edge cases, and alignment with parglare conventions. If an AI suggestion feels unclear, rewrite or drop it.
  • Keep humans in the loop: discuss non-trivial ideas early via Issues or Discussions, especially when you are unsure about design or impact.
  • Use AI for acceleration, then verify: treat AI output as a draft for code, tests, or docs; run linters/tests and review the logic yourself.
  • Be transparent in PRs: note briefly if AI was used and for what (e.g., initial draft, test scaffolding), and call out any parts where you want extra review.
  • Prefer focused patches over large dumps; if you cannot confidently explain an AI-produced change, open a well-described issue instead.

Types of Contributions

Report Bugs

Report bugs at https://github.com/igordejanovic/parglare/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. Please, discuss about your plans before implementation.

Write Documentation

parglare could always use more documentation, whether as part of the official parglare docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/igordejanovic/parglare/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up parglare for local development.

  1. Install uv Python package/project manager and just task runner.

  2. Fork the parglare repo on GitHub.

  3. Clone your fork locally:

     git clone git@github.com:your_name_here/parglare.git

  4. Create a branch for local development::

     cd parglare/
 git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes:

    • Reformat code:

      just reformat

    and verify that all checks pass:

     just check

  6. Commit your changes and push your branch to GitHub:

     git add .
 git commit -m "Your detailed description of your changes."
 git push origin name-of-your-bugfix-or-feature

    Check this on how to write nice git log messages.

  7. Submit a pull request through the GitHub website. CI will run the tests for all supported Python versions. Check in the GitHub UI that all pipelines pass.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds/changes functionality, the docs should be updated.
  3. The pull request should work for Python 3.8-3.14. Check https://travis-ci.org/igordejanovic/parglare/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

just test tests/func/mytest.py

or a single test:

just test tests/func/mytest.py::some_test

To serve docs locally:

just servedocs

To see all just options:

just