SciCatProject · sbliven · Oct 22, 2024 · Oct 22, 2024
diff --git a/Development/v3.x/Contributing.md b/Development/v3.x/Contributing.md
@@ -1,69 +1,33 @@
 # Contributing
 
-There are 3 core ways to get involved with the Data Catalogue project:
-
-1. Documentation - Fixing errors, covering weaker areas, adding examples
-2. Github Issues - This should be the first area to focus on for those that want to amend the code. To see how the project is developed, see the [Git Workflow page.](./Development_Methods.md)
-3. Testing
-
-For information about the development method we follow, please check [Development Methodology.](./Development_Methods.md)
+There are many to get involved with the SciCat project:
+
+1. Documentation - Fixing errors, covering weaker areas, adding examples. Documentation
+   is divided between the
+   [homepage](https://github.com/SciCatProject/scicatproject.github.io),
+   [documentation pages](https://github.com/SciCatProject/documentation), and READMEs in
+   the repositories.
+2. Github Issues - This should be the first area to focus on for those that want to
+   amend the code. To see how the project is developed, see the [Git Workflow
+   page.](./Development_Methods.md)
+3. [Testing](./Testing.md) - Most repositories contain unit tests. Integration between
+   components is tested with [scicatlive](https://github.com/SciCatProject/scicatlive),
+   which is also the easiest way to run and develop SciCat locally.
+4. Development - For information about the development method we follow, please check
+   [Git Flow Workflow](./Development_Methods.md).
+
+Communication is done through github issues, a slack channel, and a biweekly developer
+meeting. Please [contact](https://scicatproject.github.io/#team) the project leader, Max
+Novelli, for more information on getting involved.
 
 ## Issues
 
-Issues are handled within the Github Issue tracker and should follow the template:
-
-```markdown
-## Issue Name
-
-### Summary
-
-### Steps to Reproduce
-
-### Current Behaviour
-
-### Expected Behaviour
-
-### Extra Details
-
-Here you should include details about the system (if it is unique) and possible information about a fix (feel free to link to code where relevant). Screenshots/GIFs are also fine here.
-
-```
-
-
+Issues are handled within the Github Issue tracker. Please follow the provided template
+for each repository.
 
 ## Merge Requests
 
-There should be **no** pushing directly to the `master` or `develop` branches. To implement a fix, one should open a branch with the naming: `hotfix/ISSUE-NAME` from the `develop` branch and complete all work there. When it is complete, a Merge Request should be opened that follows this template:
-
-```markdown
-## Description
-
-## Motivation 
-
-Link to any open issues here
-
-## Fixes:
-
-* 
-*  
-
-## Changes:
-
-* 
-* 
-
-## Tests included/Docs Updated?
-
-- [ ] Included for each change/fix?
-- [ ] Passing? (Merge will not be approved unless this is checked)
-- [ ] Docs updated?
-
-## Extra Information/Screenshots
-```
-
-When the request is created, it should be assigned to any other appropriate team member with `develop` as the target branch. Tests **must** be written for all features/changes made and any major changes should be updated in the `docs` repo.
-
-
-
-
-
+There should be **no** pushing directly to the `main`, `master` or `develop` branches.
+To implement a fix, fork the repository and create a branch (eg `fix/ISSUE-NAME`)
+complete all work there. When it is complete, open a Pull Request, which will be
+reviewed and merged by the core developers.
diff --git a/Development/v3.x/README.md b/Development/v3.x/README.md
@@ -2,7 +2,7 @@
 
 This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../Operator/) for a helicopter view of the involved components.
 
-If you want to contribute to the software you should also read the [Contributing](../Development/Development_Methods.html) section, which among others links to the git workflow to be used.
+If you want to contribute to the software you should also read the [Contributing](./Contributing.md) section, which among others links to the git workflow to be used.
 
 
 # Getting an development environment set up
@@ -21,8 +21,8 @@ The most important part to understand is how loopback works, because it is the p
 
 ## Web Browser Client (Frontend)
 
-* [Angular 9+](https://angular.io/) 
-* [Angular Material Widgets and Design](https://material.angular.io/) 
+* [Angular 9+](https://angular.io/)
+* [Angular Material Widgets and Design](https://material.angular.io/)
 * [NGRX for State Management](https://ngrx.io/)
 * [Loopback SDK generator for Angular](https://github.com/mean-expert-official/loopback-sdk-builder)
 

diff --git a/Development/v4.x/README.md b/Development/v4.x/README.md
@@ -2,7 +2,7 @@
 
 This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../Operator/) for a helicopter view of the involved components.
 
-If you want to contribute to the software you should also read the [Contributing](../Development/Development_Methods.html) section, which among others links to the git workflow to be used.
+If you want to contribute to the software you should also read the [Contributing](./contributing.md) section.
 
 # Getting an development environment set up
 

diff --git a/Development/v4.x/contributing.md b/Development/v4.x/contributing.md
@@ -0,0 +1,32 @@
+# Contributing
+
+There are many to get involved with the SciCat project:
+
+1. Documentation - Fixing errors, covering weaker areas, adding examples. Documentation
+   is divided between the
+   [homepage](https://github.com/SciCatProject/scicatproject.github.io),
+   [documentation pages](https://github.com/SciCatProject/documentation), and READMEs in
+   the repositories.
+2. Github Issues - This should be the first area to focus on for those that want to
+   amend the code.
+3. [Testing](./testing.md) - Most repositories contain unit tests. Integration between
+   components is tested with [scicatlive](https://github.com/SciCatProject/scicatlive),
+   which is also the easiest way to run and develop SciCat locally.
+4. Development - Check individual repositories for more information on how to contribute
+   code. For an overview, see the [developer guide](./developers_guide.md).
+
+Communication is done through github issues, a slack channel, and a biweekly developer
+meeting. Please [contact](https://scicatproject.github.io/#team) the project leader, Max
+Novelli, for more information on getting involved.
+
+## Issues
+
+Issues are handled within the Github Issue tracker. Please follow the provided template
+for each repository.
+
+## Merge Requests
+
+There should be **no** pushing directly to the `main`, `master` or `develop` branches.
+To implement a fix, fork the repository and create a branch (eg `fix/ISSUE-NAME`)
+complete all work there. When it is complete, open a Pull Request, which will be
+reviewed and merged by the core developers.
diff --git a/Development/v4.x/developers_guide.md b/Development/v4.x/developers_guide.md
@@ -1,12 +1,12 @@
 # SciCat Data Catalogue Developer Guide
 
-This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute back to develop and improve this tool.  
+This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute back to develop and improve this tool.
 Please refer to [Overview in the Operator Manual](../Operator/) for a bird-eye view of the components that are part of SciCat.
 
-If you want to contribute to this software, please read the [Contributing](../Development/Development_Methods.html) section, which among others links to the git workflow to be used.  
+If you want to contribute to this software, please read the [Contributing](./contributing.md) section, which among others links to the git workflow to be used.
 
 ## Introduction to SciCat architecture
-SciCat architecture has been designed embracing the micro-services philosophy.  
+SciCat architecture has been designed embracing the micro-services philosophy.
 The software has two main components:
 * Frontend
 * Backend
@@ -27,8 +27,8 @@ Technologies:
 ### Frontend
 The frontend provides a single page UI application running in the browser intended to provide a easy to use interface to the backend functionalities
 Technologies:
-* [Angular 9+](https://angular.io/) 
-* [Angular Material Widgets and Design](https://material.angular.io/) 
+* [Angular 9+](https://angular.io/)
+* [Angular Material Widgets and Design](https://material.angular.io/)
 * [NGRX for State Management](https://ngrx.io/)
 * [Loopback SDK generator for Angular](https://github.com/mean-expert-official/loopback-sdk-builder)
 

diff --git a/Development/v4.x/old/Contributing.md b/Development/v4.x/old/Contributing.md
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -39,6 +39,8 @@
     - [Git Flow Workflow](Development/v3.x/Development_Methods.md)
   - [v4.x](Development/v4.x/README.md)
     - [Overview](Development/v4.x/overview.md)
+    - [Contributing](Development/v4.x/contributing.md)
+    - [Developer Guide](Development/v4.x/developers_guide.md)
     - [An Introduction to the Data Model](Development/v4.x/Data_Model.md)
     - [Running the Components](Development/v4.x/running.md)
     - [Configuration](Development/v4.x/configuration.md)