Skip to content

contributing.md

Latest commit

 

History

History
48 lines (33 loc) · 2.36 KB

contributing.md

File metadata and controls

48 lines (33 loc) · 2.36 KB
Raw

Contribution Guidelines

This repository lists "awesome" Zig projects and ecosystem tools, maintained by the ZigCC community. If you find a well-maintained library that is not yet included here, welcome to submit it via a pull request. Just be sure to execute make all before you open a PR.

TL;DR: Entry has to be actively maintained and awesome. Follow the existing style. Run make all before you open a PR.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Open an issue to start a discussion.

Ensure a pull request adheres to the following guidelines:

  • Collect anything that's useful and actively maintained
  • Follow the style guide of awesome lists to keep things organized
  • Add new entries to the end of the existing list
  • Sort entries into the archive (awesome-but-inactive.md), when needed

AI Attribution

If an entry's AI authorship materially helps readers understand the project's provenance, quality, or development process, mention it briefly in the description. Keep the wording consistent, concise, and evidence-based:

  • Use No-AI when the project has no AI involvement (0%)
  • Use AI-assisted when the project is clearly human-led with AI assistance (~1-30% AI)
  • Use AI-generated when the project is clearly described as primarily generated by AI (~70%+ AI)
  • Prefer describing the project's purpose first, then append the AI attribution if needed
  • Do not use unverified or inconsistent labels such as AI-made, vibe-coded, or LLM-written

Examples

  • - [foo/bar](https://github.com/foo/bar) - Static site generator written in Zig. No-AI.
  • - [foo/bar](https://github.com/foo/bar) - HTTP toolkit for Zig, maintained by humans. AI-assisted.
  • - [foo/bar](https://github.com/foo/bar) - Terminal game written in Zig. AI-generated.

Thank you for your suggestions!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.