Skip to content

Commit dd2bfd4

Browse files
joshkempnerjoshkempner
authored
Add supporting docs for the repo (#108)
* Update readme and add code of conduct - Add some basic info to the repo's Readme file. - Adopt the Contributor Covenant 2.1 * Add templates for bugs, feature requests, and PRs * Flesh out the Contributing doc * Add Slack link to Contributing doc * Add link to CONTRIBUTIONG from README * Add a SUPPORT file Includes a link to the Slack workspace. * Update .NET versions in CONTRIBUTING
1 parent 2503116 commit dd2bfd4

File tree

7 files changed

+260
-3
lines changed

7 files changed

+260
-3
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--
2+
Please note that although we can't commit to any timeline, priority will be given to those who are [Contributors](https://github.com/ReactiveDomain/reactive-domain#contribute ) to the project.
3+
-->
4+
5+
**Describe the bug**
6+
<!-- A clear and concise description of what the bug is. -->
7+
8+
**Steps To Reproduce**
9+
<!--
10+
Provide the steps to reproduce the behaviour:
11+
12+
​ Either link a Repo showing the error, this gives us most context for your use case scenario.
13+
14+
​ OR Following these steps
15+
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
-->
21+
22+
**Expected behaviour**
23+
<!-- A clear and concise description of what you expected to happen. -->
24+
25+
**Screenshots**
26+
<!-- If applicable, add screenshots to help explain your problem. -->
27+
28+
**Environment**
29+
<!-- Please complete the following information. -->
30+
- .NET version: <!-- [e.g. .NET Core 3.1] -->
31+
- ReactiveDomain Version: <!-- [e.g. 0.8.22.1] -->
32+
33+
**Additional context**
34+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
Please note that although we can't commit to any timeline, priority will be given to those who are [Contributors](https://github.com/ReactiveDomain/reactive-domain#contribute ) to the project.
3+
-->
4+
5+
**Is your feature request related to a problem? Please describe.**
6+
<!-- A clear and concise description of what the problem is. -->
7+
8+
9+
10+
**Describe the solution you'd like**
11+
<!-- A clear and concise description of what you want to happen. -->
12+
13+
14+
15+
**Describe alternatives you've considered**
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
17+
18+
19+
20+
**Describe suggestions on how to achieve the feature**
21+
<!-- A clear description to how to achieve the feature. -->
22+
23+
24+
25+
**Additional context**
26+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
**What does this pull request do?**
2+
<!-- A clear and concise description of the goal of this pull request -->
3+
4+
5+
**How does this pull request accomplish that goal?**
6+
<!-- A clear and concise description of the implementation -->
7+
8+
9+
**Why is this pull request important?**
10+
<!-- What does this do that couldn't be accomplished before? -->
11+
12+
13+
**Link to any issues that this resolves**
14+
<!--
15+
e.g. "Resolves #60"
16+
17+
OR
18+
19+
"This does not address any open issues."
20+
-->
21+
22+
23+
**Checklist**
24+
- [ ] All unit tests in the solution must pass on all versions of .NET that the solution supports
25+
- [ ] Any new code must be covered by at least one unit test
26+
- [ ] All public methods must be documented with XML comments

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[the Reactive Domain Slack org](https://reactivedomain.slack.com).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to ReactiveDomain
2+
3+
Contributions can take many forms: open an issue, contribute code, enhance the documentation. We welcome contribtutions of any sort to ReactiveDomain. Here are some things to keep in mind when contributing:
4+
5+
- [Code of Conduct](https://github.com/ReactiveDomain/reactive-domain/CODE_OF_CONDUCT.md)
6+
- [Issues](#issues)
7+
- [Feature Requests](#requests)
8+
- [Coding](#coding)
9+
10+
## <a href="issues"></a>Issues and Bugs
11+
Found a bug in the code or documentation? Submit an issue. Even better, submit a Pull Request to fix it!
12+
13+
## <a href="requests"></a>Feature Requests
14+
We welcome well-considered feature requests. For **major features**, please engage with us in [Slack](https://reactivedomain.slack.com) first to discuss it and work out the details. For **minor features**, feel free to submit a Pull Request right away.
15+
16+
## <a href="code"></a>Coding
17+
### Development Environment
18+
- Visual Studio 2022 (with latest patches/updates)
19+
- All versions of .NET currently supported in the solution: .NET Framework 4.8 & .NET 5.0.
20+
21+
### Coding Guidelines
22+
When submitting a Pull Request, keep these rules in mind:
23+
- All unit tests in the solution must pass on all versions of .NET that the solution supports
24+
- Any new code must be covered by at least one unit test
25+
- All public methods must be documented with XML comments

‎README.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# reactive-domain
2-
31
[![Build status](https://ci.appveyor.com/api/projects/status/oir89k5nyyouqtsm?svg=true)](https://ci.appveyor.com/project/jageall/reactive-domain)
4-
[![Build Status](https://travis-ci.org/linedata/reactive-domain.svg?branch=master)](https://travis-ci.org/linedata/reactive-domain)
2+
[![Build Status](https://travis-ci.org/linedata/reactive-domain.svg?branch=master)](https://travis-ci.org/linedata/reactive-domain)
3+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
4+
5+
# Reactive Domain
6+
7+
## Overview
8+
9+
Reactive Domain is an open source framework for implementing event sourcing in .NET projects using reactive programming principles. This includes interfaces for using [EventStoreDB](https://eventstore.com). It also provides a messaging framework and other tools for using CQRS.
10+
11+
The framework is highly opinionated. It focuses on using a small number of consistent patterns and design principles in its public interfaces to enable developers to get up to speed quickly. Ease of use and "design for code review" have been the driving forces behind the framework's evolution. Where trade-offs have been necessary, these principles have been emphasized over performance.
12+
13+
## Contributing
14+
15+
Pull requests are welcome! Take a look at the open issues, join our [discussion on Slack](https://reactivedomain.slack.com), or contribute in an area where you see a need. Contributors and participants on our Slack channels are expected to abide by the project's [code of conduct](CODE_OF_CONDUCT.md). Read the full guidelines on [contributing](CONTRIBUTING.md).

‎SUPPORT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Support
2+
3+
For help getting started with ReactiveDomain or to discuss issues you encounter, join the [discussion on Slack](https://reactivedomain.slack.com).

0 commit comments

Comments
 (0)