From 9c4a79a7d1bf6c7a03ee36d80c18bd8abfc440a2 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Mon, 7 Jul 2025 11:53:59 +0100 Subject: [PATCH 1/3] adding CONTRIBUTING.md file --- CONTRIBUTION.md | 0 README.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md index 037ff673..eff55ad6 100644 --- a/README.md +++ b/README.md @@ -45,4 +45,4 @@ npm run start ## Publishing the documentation The [website](https://scicatproject.github.io/documentation) will be automatically -rebuilt after each change to the `master` branch by a github action. +rebuilt after each change to the `master` branch by a github action. \ No newline at end of file From c94f064069a5a8ad8fdf58eed6c6bf2f1dfc7085 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Mon, 7 Jul 2025 12:02:20 +0100 Subject: [PATCH 2/3] adding guidelines on style, purpose and audience --- CONTRIBUTION.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index e69de29b..5d5b5506 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -0,0 +1,17 @@ +# Contributing to Documentation + +For writing and style guidelines we follow the best practices for Github Docs outlined here https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs. + +## Purpose + +This documentation aims to: +* provide detailed information about the structure of the software +* guidance on deployment +* detailed description of features +* guidance on configuration + +## Audience + +These documents are written for developers and site-administrators. These documents are desgined to include technical details that will be understood by people with previous programming and DevOps experience. + +To contribute or read information aimed at a non-technical audience please see our (user-documentation)[https://github.com/SciCatProject/user-documentation]. From d63fa1b57919ec9ecdf02da5f40b4045f3caf6e1 Mon Sep 17 00:00:00 2001 From: vpf26432 Date: Mon, 7 Jul 2025 13:27:49 +0100 Subject: [PATCH 3/3] adding guidelines for submission and out of scope --- CONTRIBUTION.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 5d5b5506..d07578f0 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,5 +1,7 @@ # Contributing to Documentation +Thanks so much for reading these guidelines. We welcome contributions to our documentation. + For writing and style guidelines we follow the best practices for Github Docs outlined here https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs. ## Purpose @@ -15,3 +17,15 @@ This documentation aims to: These documents are written for developers and site-administrators. These documents are desgined to include technical details that will be understood by people with previous programming and DevOps experience. To contribute or read information aimed at a non-technical audience please see our (user-documentation)[https://github.com/SciCatProject/user-documentation]. + +## Submission + +To make changes to the documentation please make a fork of this repository. When you have finished your contribution please raise a pull request into the `master` branch of the documentation. Your contribution will be reviewed before it is merged. + +## Out of Scope +The documentation describes the features of the frontend and backend of the SciCat software at a technical level. User facing documentation is outside the scope of this documentation and should be submitted to: (user-documentation)[https://github.com/SciCatProject/user-documentation] + +Site specific documentation should not be included here, unless it is generalised as an example. + + +