Skip to content

Commit 6f815a6

Browse files
committed
Add prompt to stage site, and other minor edits
1 parent b464927 commit 6f815a6

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,26 @@ Clone _*your copy*_ of the repository. Where `<user>` is your github username:
4040
git clone [email protected]:<user>/codemeta.github.io.git
4141
```
4242

43-
There should be an issue open that discusses this change. Open an new issue if
43+
There should be an issue open that discusses this change. Open a new issue if
4444
one does not already exist:
4545

4646
[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/codemeta/codemeta.github.io)](https://github.com/codemeta/codemeta.github.io/issues)
4747

48-
(Optional) Create a new branch for your change. This keeps your `master` branch
49-
clear of changes, which can make it difficult to keep it in sync with the
50-
original repository. The following would create a branch named for issue #999:
48+
(Optional) Create a new branch for your change. This keeps your `master`
49+
branch clear of changes, which can make it difficult to keep it in sync with
50+
the original repository. The following would create a branch named for issue
51+
#999:
5152

5253
```
5354
git checkout -b "issue-999"
5455
```
5556

56-
Make your changes as discussed and commit them to your local copy. Include the
57+
Make your changes as discussed, then run Hugo to make sure the changes are
58+
correct and nothing has broken.
59+
[Refer to the staging instructions](https://github.com/codemeta/codemeta.github.io?tab=readme-ov-file#staging-the-site)
60+
for how to preview your changes locally.
61+
62+
Add and commit your changed files to your local repository copy. Include the
5763
issue number somewhere in a commit message, prefixed with a `#`, eg, `#999`.
5864
This will prompt GitHub to create a link back to the issue.
5965

@@ -69,8 +75,8 @@ git push origin issue-999
6975
GitHub will prompt you to open a Pull Request. Open the Pull Request against
7076
the `master` branch.
7177

72-
If the maintainers agree with your change, it will be merged. Otherwise it
73-
will be discussed and possibly edited in the Pull Request process.
78+
If the maintainers agree with your change, it will be merged. If they do not,
79+
it will be discussed and possibly edited in the Pull Request process.
7480

7581
### Updating Scripts
7682

@@ -150,8 +156,8 @@ The cards are generated sorted by name.
150156
#### RSMD Carousel
151157

152158
If the [Research Software Metadata Guidelines](https://fair-impact.github.io/RSMD-guidelines/)
153-
working group releases new Aspects promoting CodeMeta, they should be added to
154-
carousel on the front page. The carousel is built from `/data/rsmd.json`.
159+
working group releases new Aspects promoting CodeMeta, they should be added
160+
to carousel on the front page. The carousel is built from `/data/rsmd.json`.
155161

156162
To add a new Aspect:
157163

0 commit comments

Comments
 (0)