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: README.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,7 @@ The following scripts are made available via [package.json](./package.json):
77
77
78
78
### Reporting an Issue
79
79
80
-
Issues for ArchivesSpace's technical documentation are [tracked in Jira.](https://archivesspace.atlassian.net/jira/software/projects/TD/boards/57) If there isn't a ticket in this system, go ahead and make one. Be
80
+
Issues for ArchivesSpace's technical documentation are [tracked in Jira.](https://archivesspace.atlassian.net/jira/software/projects/TD/boards/57) If there isn't a ticket in this system, go ahead and make one. Be
81
81
sure to include a **title and clear description** with as much relevant
82
82
information as possible.
83
83
@@ -86,7 +86,7 @@ information as possible.
86
86
#### Fork & create a branch
87
87
88
88
When you are ready to start working on an issue, please assign it to yourself
89
-
as an indication that you are working on it. Then [fork ArchivesSpace][] and
89
+
as an indication that you are working on it. Then [fork TechDocs][https://github.com/archivesspace/tech-docs/fork] and
90
90
create a branch with a descriptive name.
91
91
92
92
A good branch name would include the ticket number in it. For example, if you
@@ -105,8 +105,7 @@ Before running any tests, you will need to set up your environment. See [Running
105
105
At this point, you're ready to make your changes! Feel free to ask for help;
106
106
remember everyone is a beginner at first
107
107
108
-
* ArchivesSpace Program Team - ArchivesSpaceHome@lyrasis.org
109
-
108
+
- ArchivesSpace Program Team - ArchivesSpaceHome@lyrasis.org
110
109
111
110
#### Run tests and style code
112
111
@@ -117,7 +116,6 @@ npm run prettier:fix
117
116
npm run stylelint:fix
118
117
```
119
118
120
-
121
119
#### Make a Pull Request
122
120
123
121
At this point, you should switch back to your main branch and make sure it's
Finally, go to GitHub and [make a Pull Request][https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request]:D
141
139
142
-
TravisCI will run all test suites against the pushed branch. We care about
143
-
quality, so your Pull Request won't be merged until all test suites pass.
140
+
Our CI process will run all test suites against the pushed branch. We care about
141
+
quality, so your Pull Request won't be merged until all test suites pass. If any linting checks fail, the PR reviewer can fix those issues.
144
142
145
143
##### What happens after you submit a Pull Request?
146
144
@@ -156,8 +154,8 @@ Pull Request. Once the comment/questions have been answered/resolved, a Pull
156
154
Request can only be accepted and merged into the core code base by a core
0 commit comments