Skip to content

Commit 7f88bb9

Browse files
authored
Add references to CONTRIBUTING. (#106)
Refer contributors to relevant documentation.
2 parents e8558c0 + 1b22b55 commit 7f88bb9

3 files changed

Lines changed: 10 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ To get in touch with us you may contact a [contributor](https://github.com/Task-
2929

3030
Before submitting to this repository, please:
3131

32+
* Familiarize yourself with the
33+
[software architecture documentation](<\ref software_architecture> "software architecture documentation")
34+
and the
35+
[design decisions](<\ref doc/decisions> "design decisions").
3236
* Test your contribution.
3337
* Make sure your code does not introduce warnings or errors.
3438
* Your proposition may be reviewed based on state of the art coding standards (for example [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/) or [C++ Super FAQ](https://isocpp.org/faq)).

doc/decisions/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
\dir .
2-
\brief Documentation of Decisions
2+
\brief \ref decision_records
3+
4+
\page decision_records Decision Records
5+
\brief Documentation of decisions for the software, its architecture and design.
36

47
This directory contains the documentation of design decisions made for the software.
5-
In particular it may contain descision records in the
8+
In particular it may contain decision records in the
69
Architecture Decisions Records format described by Michael Nygard
710
[here](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).
811
Those shall be kept in files named using the pattern `dr-XYZ.md`.

doc/software-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Software Architecture
1+
Software Architecture {#software_architecture}
22
=====================
33

44
[TOC]

0 commit comments

Comments
 (0)