From c74539da95ea2814d7381be3aefafb74db05a7bc Mon Sep 17 00:00:00 2001 From: Teresia Olsson Date: Fri, 30 Jan 2026 14:04:04 +0100 Subject: [PATCH 1/2] Add instructions for how to contribute. --- docs/getting-started/contribute.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/contribute.md b/docs/getting-started/contribute.md index 90e744b6..a83b03dd 100644 --- a/docs/getting-started/contribute.md +++ b/docs/getting-started/contribute.md @@ -1,4 +1,23 @@ How to Contribute -====== +================= -To write... \ No newline at end of file +There are several ways to contribute to the code. + +## Report an Issue + +If you have found an issue, go the the issues tab in the corresponding repository and write a description of the problem. +Add the steps you did and an example showing the issue to help with the debugging. + +If you have questions you can also put that in the issues. + +## Make Pull Requests + +You are very welcome to add your own developments or fix bugs in the code. + +1. If you are not a maintainer, fork the repository you want to work on. + +2. Make a {doc}`developer installation <./installation>`. + +3. Create a new branch for your development, commit your changes and push it to your fork. + +4. Then on the Github webpage you can create a pull request to merge into the original repository. From 36a64f459f7c0cb7efd6f36d06a5e18c21d6340a Mon Sep 17 00:00:00 2001 From: Teresia Olsson Date: Fri, 30 Jan 2026 16:46:33 +0100 Subject: [PATCH 2/2] Changed so the contribute page in the docs links to the contribute readme in the root. --- docs/getting-started/contribute.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/docs/getting-started/contribute.md b/docs/getting-started/contribute.md index a83b03dd..5e0621cd 100644 --- a/docs/getting-started/contribute.md +++ b/docs/getting-started/contribute.md @@ -1,23 +1,5 @@ How to Contribute ================= -There are several ways to contribute to the code. - -## Report an Issue - -If you have found an issue, go the the issues tab in the corresponding repository and write a description of the problem. -Add the steps you did and an example showing the issue to help with the debugging. - -If you have questions you can also put that in the issues. - -## Make Pull Requests - -You are very welcome to add your own developments or fix bugs in the code. - -1. If you are not a maintainer, fork the repository you want to work on. - -2. Make a {doc}`developer installation <./installation>`. - -3. Create a new branch for your development, commit your changes and push it to your fork. - -4. Then on the Github webpage you can create a pull request to merge into the original repository. +```{include} ../../CONTRIBUTING.md +:start-after: "# Contributing to [Python Accelerator Middle Layer (PyAML)]"