From 657fde83988996a723a323509b04d67b7f91a34f Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Tue, 27 May 2025 06:28:24 +0000 Subject: [PATCH 1/4] DOCS: Add short contributing guide --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..933fa4e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Thank you for your interest in contributing to `meson-python`! + +## How to Contribute + +1. **Fork the repository** and create your branch from `main`. +2. **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. +3. **Make your changes** and add tests if applicable. +4. **Run the test suite** to ensure all tests pass: `pytest` from the project root. +5. **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. From 48dacf1eaf29ccd7fd404f9b73d3cc23203fa4d1 Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Thu, 29 May 2025 22:33:06 +0800 Subject: [PATCH 2/4] Add install ninja step --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 933fa4e5..79c2096f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,13 +5,14 @@ Thank you for your interest in contributing to `meson-python`! ## How to Contribute 1. **Fork the repository** and create your branch from `main`. -2. **Setup development environment** using `pip install -e .[test]`. +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. -3. **Make your changes** and add tests if applicable. -4. **Run the test suite** to ensure all tests pass: `pytest` from the project root. -5. **Submit a pull request** with a clear description of your changes. +4. **Make your changes** and add tests if applicable. +5. **Run the test suite** to ensure all tests pass: `pytest` from the project root. +6. **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. From 356a60490f17979b7a71a061998afb013d9b25f2 Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Thu, 29 May 2025 22:36:51 +0800 Subject: [PATCH 3/4] Fix linter --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79c2096f..75be4480 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,11 @@ Thank you for your interest in contributing to `meson-python`! 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. -4. **Make your changes** and add tests if applicable. -5. **Run the test suite** to ensure all tests pass: `pytest` from the project root. -6. **Submit a pull request** with a clear description of your changes. +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. From 9713f9617efeaa11cfaabb25af14f5900790060b Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Sat, 31 May 2025 19:03:15 +0800 Subject: [PATCH 4/4] Add copyright info --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75be4480..e3401424 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ + + # Contributing Thank you for your interest in contributing to `meson-python`!