Skip to content

DOC: Add short contributing guide #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DOC: Add short contributing guide #752

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
657fde8
DOCS: Add short contributing guide
tobiasdiez May 27, 2025
48dacf1
Add install ninja step
tobiasdiez May 29, 2025
356a604
Fix linter
tobiasdiez May 29, 2025
9713f96
Add copyright info
tobiasdiez May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--
SPDX-FileCopyrightText: 2021 The meson-python developers

SPDX-License-Identifier: MIT
-->

# Contributing
Copy link
Member

Choose a reason for hiding this comment

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

All other meson-python documentation is in reST format. This should be too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

According to https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types only md files are supported (and is also confirmed by looking at some repose that do have contributing.rst file).

Copy link
Member

Choose a reason for hiding this comment

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

The only thing that the GitHub native support for CONTRIBUTING.md does is to show the content when a new pull request is opened. I argue that the proposed content is only relevant to help contributors in the stage of development that come before the point of preparing a PR, thus I see the GitHub native support for CONTRIBUTING.md only showing the added documentation in the wrong context. I much prefer having all the documentation in a uniform format and, eventually, being able to link it to the rendered HTML documentation.

Copy link
Member

Choose a reason for hiding this comment

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

This is missing a license header (this is the reason why the CI fails).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

Copy link
Member

Choose a reason for hiding this comment

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

Did you really write this in 2021 and waited till now to submit the PR? 🙂


Thank you for your interest in contributing to `meson-python`!

## How to Contribute

1. **Fork the repository** and create your branch from `main`.
2. **Install Ninja** either using your system package manager (preferred) or via `pip install ninja`.
3. **Setup development environment** using `pip install -e .[test]`.
This will install as well all necessary dependencies for development and testing.

It is recommended to use a virtual environment to avoid conflicts with system packages.
5. **Make your changes** and add tests if applicable.
6. **Run the test suite** to ensure all tests pass: `pytest` from the project root.
7. **Submit a pull request** with a clear description of your changes.

## Code Style
- Follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide, but with a line length of 127 characters.
- Use Ruff for linting.
Loading