You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,16 @@ assignees: ''
7
7
8
8
---
9
9
10
-
**Describe the bug**
10
+
## Describe the bug
11
11
A clear and concise description of what the bug is. Include the version(s) of DSpace where you've seen this problem & what *web browser* you were using. Link to examples if they are public.
12
12
13
-
**To Reproduce**
13
+
## To Reproduce
14
14
Steps to reproduce the behavior:
15
15
1. Do this
16
16
2. Then this...
17
17
18
-
**Expected behavior**
18
+
## Expected behavior
19
19
A clear and concise description of what you expected to happen.
_Add references/links to any related issues or PRs. These may include:_
3
-
* Fixes #`issue-number` (if this fixes an issue ticket)
4
-
* Requires DSpace/DSpace#`pr-number` (if a REST API PR is required to test this)
3
+
* Fixes #issue-number (if this fixes an issue ticket)
4
+
* Requires DSpace/DSpace#pr-number (if a REST API PR is required to test this)
5
5
6
6
## Description
7
7
Short summary of changes (1-2 sentences).
@@ -16,13 +16,18 @@ List of changes in this PR:
16
16
**Include guidance for how to test or review your PR.** This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.
17
17
18
18
## Checklist
19
-
_This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_
19
+
_This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
20
+
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_
20
21
21
-
-[ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
22
-
-[ ] My PR passes [ESLint](https://eslint.org/) validation using `yarn lint`
23
-
-[ ] My PR doesn't introduce circular dependencies (verified via `yarn check-circ-deps`)
24
-
-[ ] My PR includes [TypeDoc](https://typedoc.org/) comments for _all new (or modified) public methods and classes_. It also includes TypeDoc for large or complex private methods.
25
-
-[ ] My PR passes all specs/tests and includes new/updated specs or tests based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide).
22
+
-[ ] My PR is **created against the `main` branch** of code (unless it is a backport or is fixing an issue specific to an older branch).
23
+
-[ ] My PR is **small in size** (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
24
+
-[ ] My PR **passes [ESLint](https://eslint.org/)** validation using `yarn lint`
25
+
-[ ] My PR **doesn't introduce circular dependencies** (verified via `yarn check-circ-deps`)
26
+
-[ ] My PR **includes [TypeDoc](https://typedoc.org/) comments** for _all new (or modified) public methods and classes_. It also includes TypeDoc for large or complex private methods.
27
+
-[ ] My PR **passes all specs/tests and includes new/updated specs or tests** based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide).
28
+
-[ ] My PR **aligns with [Accessibility guidelines](https://wiki.lyrasis.org/display/DSDOC8x/Accessibility)** if it makes changes to the user interface.
29
+
-[ ] My PR **uses i18n (internationalization) keys** instead of hardcoded English text, to allow for translations.
30
+
-[ ] My PR **includes details on how to test it**. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
26
31
-[ ] If my PR includes new libraries/dependencies (in `package.json`), I've made sure their licenses align with the [DSpace BSD License](https://github.com/DSpace/DSpace/blob/main/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation.
27
32
-[ ] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
28
33
-[ ] If my PR fixes an issue ticket, I've [linked them together](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,17 @@ DSpace is a community built and supported project. We do not have a centralized
10
10
## Contribute new code via a Pull Request
11
11
12
12
We accept [GitHub Pull Requests (PRs)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) at any time from anyone.
13
-
Contributors to each release are recognized in our [Release Notes](https://wiki.lyrasis.org/display/DSDOC7x/Release+Notes).
13
+
Contributors to each release are recognized in our [Release Notes](https://wiki.lyrasis.org/display/DSDOC8x/Release+Notes).
14
14
15
15
Code Contribution Checklist
16
16
-[ ] PRs _should_ be smaller in size (ideally less than 1,000 lines of code, not including comments & tests)
17
17
-[ ] PRs **must** pass [ESLint](https://eslint.org/) validation using `yarn lint`
18
18
-[ ] PRs **must** not introduce circular dependencies (verified via `yarn check-circ-deps`)
19
19
-[ ] PRs **must** include [TypeDoc](https://typedoc.org/) comments for _all new (or modified) public methods and classes_. Large or complex private methods should also have TypeDoc.
20
20
-[ ] PRs **must** pass all automated pecs/tests and includes new/updated specs or tests based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide).
21
+
-[ ] User interface changes **must** align with [Accessibility guidelines](https://wiki.lyrasis.org/display/DSDOC8x/Accessibility)
22
+
-[ ] PRs **must** use i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
23
+
-[ ] Details on how to test the PR **must** be provided. Reviewers must be aware of any steps they need to take to successfully test your fix or feature.
21
24
-[ ] If a PR includes new libraries/dependencies (in `package.json`), then their software licenses **must** align with the [DSpace BSD License](https://github.com/DSpace/dspace-angular/blob/main/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation.
22
25
-[ ] Basic technical documentation _should_ be provided for any new features or configuration, either in the PR itself or in the DSpace Wiki documentation.
23
26
-[ ] If a PR fixes an issue ticket, please [link them together](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
@@ -26,21 +29,21 @@ Additional details on the code contribution process can be found in our [Code Co
26
29
27
30
## Contribute documentation
28
31
29
-
DSpace Documentation is a collaborative effort in a shared Wiki. The latest documentation is at https://wiki.lyrasis.org/display/DSDOC7x
32
+
DSpace Documentation is a collaborative effort in a shared Wiki. The latest documentation is at https://wiki.lyrasis.org/display/DSDOC
30
33
31
34
If you find areas of the DSpace Documentation which you wish to improve, please request a Wiki account by emailing wikihelp@lyrasis.org.
32
35
Once you have an account setup, contact @tdonohue (via [Slack](https://wiki.lyrasis.org/display/DSPACE/Slack) or email) for access to edit our Documentation.
33
36
34
37
## Help others on mailing lists or Slack
35
38
36
39
DSpace has our own [Slack](https://wiki.lyrasis.org/display/DSPACE/Slack) community and [Mailing Lists](https://wiki.lyrasis.org/display/DSPACE/Mailing+Lists) where discussions take place and questions are answered.
37
-
Anyone is welcome to join and help others. We just ask you to follow our [Code of Conduct](https://www.lyrasis.org/about/Pages/Code-of-Conduct.aspx) (adopted via LYRASIS).
40
+
Anyone is welcome to join and help others. We just ask you to follow our [Code of Conduct](https://www.lyrasis.org/about/Pages/Code-of-Conduct.aspx) (adopted via Lyrasis).
38
41
39
42
## Join a working or interest group
40
43
41
44
Most of the work in building/improving DSpace comes via [Working Groups](https://wiki.lyrasis.org/display/DSPACE/DSpace+Working+Groups) or [Interest Groups](https://wiki.lyrasis.org/display/DSPACE/DSpace+Interest+Groups).
42
45
43
46
All working/interest groups are open to anyone to join and participate. A few key groups to be aware of include:
44
47
45
-
*[DSpace 7 Working Group](https://wiki.lyrasis.org/display/DSPACE/DSpace+7+Working+Group) - This is the main (mostly volunteer) development team. We meet weekly to review our current development [project board](https://github.com/orgs/DSpace/projects), assigning tickets and/or PRs.
46
-
*[DSpace Community Advisory Team (DCAT)](https://wiki.lyrasis.org/display/cmtygp/DSpace+Community+Advisory+Team) - This is an interest group for repository managers/administrators. We meet monthly to discuss DSpace, share tips & provide feedback back to developers.
48
+
*[DSpace Developer Team](https://wiki.lyrasis.org/display/DSPACE/Developer+Meetings) - This is the primary, volunteer development team. We meet weekly to review our current development [project board](https://github.com/orgs/DSpace/projects), assigning tickets and/or PRs. This is also were discussions of the next release or major issues occur. Anyone is welcome to attend.
49
+
*[DSpace Community Advisory Team (DCAT)](https://wiki.lyrasis.org/display/cmtygp/DSpace+Community+Advisory+Team) - This is an interest group for repository managers/administrators. We meet monthly to discuss DSpace, share tips & provide feedback back to developers. Anyone is welcome to attend.
Copy file name to clipboardExpand all lines: docker/README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,19 +59,19 @@ A default/demo version of this image is built *automatically*.
59
59
60
60
## To refresh / pull DSpace images from Dockerhub
61
61
```
62
-
docker-compose -f docker/docker-compose.yml pull
62
+
dockercompose -f docker/docker-compose.yml pull
63
63
```
64
64
65
65
## To build DSpace images using code in your branch
66
66
```
67
-
docker-compose -f docker/docker-compose.yml build
67
+
dockercompose -f docker/docker-compose.yml build
68
68
```
69
69
70
70
## To start DSpace (REST and Angular) from your branch
71
71
72
72
This command provides a quick way to start both the frontend & backend from this single codebase
73
73
```
74
-
docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
74
+
dockercompose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
75
75
```
76
76
77
77
Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
@@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network
86
86
87
87
From 'DSpace/DSpace' clone (build first as needed):
88
88
```
89
-
docker-compose -p d8 up -d
89
+
dockercompose -p d8 up -d
90
90
```
91
91
92
92
NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).
93
93
94
94
From 'DSpace/dspace-angular' clone (build first as needed)
95
95
```
96
-
docker-compose -p d8 -f docker/docker-compose.yml up -d
96
+
dockercompose -p d8 -f docker/docker-compose.yml up -d
97
97
```
98
98
99
99
At this point, you should be able to access the UI from http://localhost:4000,
@@ -105,40 +105,40 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
105
105
(https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).
Load assetstore content and trigger a re-index of the repository
134
134
```
135
-
docker-compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
135
+
dockercompose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
136
136
```
137
137
138
138
## End to end testing of the REST API (runs in GitHub Actions CI).
139
139
_In this instance, only the REST api runs in Docker using the Entities dataset. GitHub Actions will perform CI testing of Angular using Node to drive the tests. See `.github/workflows/build.yml` for more details._
140
140
141
141
This command is only really useful for testing our Continuous Integration process.
142
142
```
143
-
docker-compose -p d8ci -f docker/docker-compose-ci.yml up -d
143
+
dockercompose -p d8ci -f docker/docker-compose-ci.yml up -d
0 commit comments