|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -There are 3 core ways to get involved with the Data Catalogue project: |
4 | | - |
5 | | -1. Documentation - Fixing errors, covering weaker areas, adding examples |
6 | | -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) |
7 | | -3. Testing |
8 | | - |
9 | | -For information about the development method we follow, please check [Development Methodology.](./Development_Methods.md) |
| 3 | +There are many to get involved with the SciCat project: |
| 4 | + |
| 5 | +1. Documentation - Fixing errors, covering weaker areas, adding examples. Documentation |
| 6 | + is divided between the |
| 7 | + [homepage](https://github.com/SciCatProject/scicatproject.github.io), |
| 8 | + [documentation pages](https://github.com/SciCatProject/documentation), and READMEs in |
| 9 | + the repositories. |
| 10 | +2. Github Issues - This should be the first area to focus on for those that want to |
| 11 | + amend the code. To see how the project is developed, see the [Git Workflow |
| 12 | + page.](./Development_Methods.md) |
| 13 | +3. [Testing](./Testing.md) - Most repositories contain unit tests. Integration between |
| 14 | + components is tested with [scicatlive](https://github.com/SciCatProject/scicatlive), |
| 15 | + which is also the easiest way to run and develop SciCat locally. |
| 16 | +4. Development - For information about the development method we follow, please check |
| 17 | + [Git Flow Workflow](./Development_Methods.md). |
| 18 | + |
| 19 | +Communication is done through github issues, a slack channel, and a biweekly developer |
| 20 | +meeting. Please [contact](https://scicatproject.github.io/#team) the project leader, Max |
| 21 | +Novelli, for more information on getting involved. |
10 | 22 |
|
11 | 23 | ## Issues |
12 | 24 |
|
13 | | -Issues are handled within the Github Issue tracker and should follow the template: |
14 | | - |
15 | | -```markdown |
16 | | -## Issue Name |
17 | | - |
18 | | -### Summary |
19 | | - |
20 | | -### Steps to Reproduce |
21 | | - |
22 | | -### Current Behaviour |
23 | | - |
24 | | -### Expected Behaviour |
25 | | - |
26 | | -### Extra Details |
27 | | - |
28 | | -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. |
29 | | - |
30 | | -``` |
31 | | - |
32 | | - |
| 25 | +Issues are handled within the Github Issue tracker. Please follow the provided template |
| 26 | +for each repository. |
33 | 27 |
|
34 | 28 | ## Merge Requests |
35 | 29 |
|
36 | | -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: |
37 | | - |
38 | | -```markdown |
39 | | -## Description |
40 | | - |
41 | | -## Motivation |
42 | | - |
43 | | -Link to any open issues here |
44 | | - |
45 | | -## Fixes: |
46 | | - |
47 | | -* |
48 | | -* |
49 | | - |
50 | | -## Changes: |
51 | | - |
52 | | -* |
53 | | -* |
54 | | - |
55 | | -## Tests included/Docs Updated? |
56 | | - |
57 | | -- [ ] Included for each change/fix? |
58 | | -- [ ] Passing? (Merge will not be approved unless this is checked) |
59 | | -- [ ] Docs updated? |
60 | | - |
61 | | -## Extra Information/Screenshots |
62 | | -``` |
63 | | - |
64 | | -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. |
65 | | - |
66 | | - |
67 | | - |
68 | | - |
69 | | - |
| 30 | +There should be **no** pushing directly to the `main`, `master` or `develop` branches. |
| 31 | +To implement a fix, fork the repository and create a branch (eg `fix/ISSUE-NAME`) |
| 32 | +complete all work there. When it is complete, open a Pull Request, which will be |
| 33 | +reviewed and merged by the core developers. |
0 commit comments