Skip to content

Commit b494ef9

Browse files
bonniegeebrianzelip
authored andcommitted
add requested changes
1 parent 4017243 commit b494ef9

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The following scripts are made available via [package.json](./package.json):
7777

7878
### Reporting an Issue
7979

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
8181
sure to include a **title and clear description** with as much relevant
8282
information as possible.
8383

@@ -86,7 +86,7 @@ information as possible.
8686
#### Fork & create a branch
8787

8888
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
9090
create a branch with a descriptive name.
9191

9292
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
105105
At this point, you're ready to make your changes! Feel free to ask for help;
106106
remember everyone is a beginner at first
107107

108-
* ArchivesSpace Program Team - ArchivesSpaceHome@lyrasis.org
109-
108+
- ArchivesSpace Program Team - ArchivesSpaceHome@lyrasis.org
110109

111110
#### Run tests and style code
112111

@@ -117,7 +116,6 @@ npm run prettier:fix
117116
npm run stylelint:fix
118117
```
119118

120-
121119
#### Make a Pull Request
122120

123121
At this point, you should switch back to your main branch and make sure it's
@@ -139,8 +137,8 @@ git push --set-upstream origin TD-123-descriptive-short-title
139137

140138
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
141139

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.
144142

145143
##### What happens after you submit a Pull Request?
146144

@@ -156,8 +154,8 @@ Pull Request. Once the comment/questions have been answered/resolved, a Pull
156154
Request can only be accepted and merged into the core code base by a core
157155
committer if:
158156

159-
* All test suites are passing.
160-
* It is up-to-date with current main.
157+
- All test suites are passing.
158+
- It is up-to-date with current main.
161159

162160
## 📖 Additional Resources
163161

0 commit comments

Comments
 (0)