Skip to content

Commit

Permalink
Use mailto addresses and backticks
Browse files Browse the repository at this point in the history
  • Loading branch information
replaceafill committed Nov 30, 2023
1 parent 4dcf6e9 commit bcc7d90
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Archivematica itself.
## Submitting bugs

If you find a security vulnerability, do NOT open an issue. Email
[email protected] instead.
[[email protected]](mailto:[email protected]) instead.

Issues can be filed using GitHub Issues in the [Archivematica Issues repo].
It is recommended to file issues there rather than in any of the
Expand Down Expand Up @@ -182,7 +182,8 @@ The Archivematica contributor's agreement is based almost verbatim on the
[Apache Foundation]'s individual [contributor license].

If you have any questions or concerns about the Contributor's Agreement,
please email us at [email protected] to discuss them.
please email us at [[email protected]](mailto:[email protected])
to discuss them.

### Why do I have to sign a Contributor's Agreement?

Expand All @@ -209,7 +210,7 @@ be, rather than fighting legal battles over contributions.
### How do I send in an agreement?

Please read and sign the [Contributor's Agreement] and email it to
[email protected].
[[email protected]](mailto:[email protected]).

Alternatively, you may send a printed, signed agreement to:

Expand Down Expand Up @@ -350,21 +351,29 @@ and b) what the change is. For example:

Clear commit summary:

> Replace 404 messages with a user-friendly one
```
Replace 404 messages with a user-friendly one
```

Unclear commit summaries:

> Fixed some normalization bugs
```
Fixed some normalization bugs
```

> Bugfixes
```
Bugfixes
```

The unclear messages make it hard to tell at a glance what changed, and that
makes browsing the commit history harder.

A commit message should use the [imperative mood] which should always be able to
complete the following sentence:

If applied, this commit will <your subject line here>
```
If applied, this commit will <your subject line here>
```

#### Commit messages should be as detailed as they need to be (and no more)

Expand Down Expand Up @@ -395,6 +404,7 @@ two together.
Further content comes after a blank line.
```

[documentation]: https://github.com/artefactual/archivematica-docs/
[mailing list]: https://groups.google.com/forum/#!forum/archivematica
[Archivematica Issues repo]: https://github.com/archivematica/Issues
Expand Down

0 comments on commit bcc7d90

Please sign in to comment.