Skip to content

docs: add comprehensive contributing guide#149

Merged
mergify[bot] merged 4 commits into
mainfrom
dosu/doc-update-124-1
Mar 6, 2026
Merged

docs: add comprehensive contributing guide#149
mergify[bot] merged 4 commits into
mainfrom
dosu/doc-update-124-1

Conversation

@dosubot
Copy link
Copy Markdown
Contributor

@dosubot dosubot Bot commented Mar 6, 2026

Update documentation for #124

Add a complete CONTRIBUTING.md file with guidelines for developers contributing to libmagic-rs. The guide covers development setup, project architecture, code quality requirements, testing standards, documentation practices, PR submission workflow, style guidelines, and project governance. This provides contributors with clear expectations and processes for participating in the project.

Generated by Dosu

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Mar 6, 2026
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Mar 6, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 CI must pass

Wonderful, this rule succeeded.

All CI checks must pass. Release-plz PRs are exempt because they only bump versions and changelogs (code was already tested on main), and GITHUB_TOKEN-triggered force-pushes suppress CI.

  • check-success = coverage
  • check-success = quality
  • check-success = test
  • check-success = test-cross-platform (macos-latest, macOS)
  • check-success = test-cross-platform (ubuntu-22.04, Linux)
  • check-success = test-cross-platform (ubuntu-latest, Linux)
  • check-success = test-cross-platform (windows-latest, Windows)

🟢 Do not merge outdated PRs

Wonderful, this rule succeeded.

Make sure PRs are within 10 commits of the base branch before merging

  • #commits-behind <= 3

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Mar 6, 2026
Copy link
Copy Markdown
Contributor

@mergify mergify Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatically approved by Mergify

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Mar 6, 2026

🧪 CI Insights

Here's what we observed from your CI run for e600a06.

🟢 All jobs passed!

But CI Insights is watching 👀

@mergify mergify Bot merged commit 64dbfb5 into main Mar 6, 2026
25 checks passed
@mergify mergify Bot deleted the dosu/doc-update-124-1 branch March 6, 2026 05:15
@github-actions github-actions Bot mentioned this pull request Mar 6, 2026
mergify Bot pushed a commit that referenced this pull request Mar 6, 2026
## 🤖 New release

* `libmagic-rs`: 0.3.2 -> 0.4.0 (⚠ API breaking changes)

### ⚠ `libmagic-rs` breaking changes

```text
--- failure enum_variant_added: enum variant added on exhaustive enum ---

Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.46.0/src/lints/enum_variant_added.ron

Failed in:
  variant Operator:BitwiseXor in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:252
  variant Operator:BitwiseNot in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:263
  variant Operator:AnyValue in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:274
  variant Operator:BitwiseXor in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:252
  variant Operator:BitwiseNot in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:263
  variant Operator:AnyValue in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:274
  variant Operator:BitwiseXor in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:252
  variant Operator:BitwiseNot in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:263
  variant Operator:AnyValue in /tmp/.tmp8YIKcr/libmagic-rs/src/parser/ast.rs:274
```

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

## [0.4.0] - 2026-03-06

### Features

- **parser**: Implement bitwise xor not and any value x operators
([#145](#145))

### Documentation

- Add comprehensive contributing guide
([#149](#149))
<!-- generated by git-cliff -->
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants