Skip to content

Commit 9e06180

Browse files
authored
Feature documentation (#21)
* Add Example Documents Added a CODE-OF-CONDUCT.md and a CONTRIBUTING.md * Edit the CONTRIBUTING.md * Fix Broken and Missing Links Fix links in the CONTRIBUTIN.md document
1 parent 4a78a3b commit 9e06180

File tree

3 files changed

+147
-0
lines changed

3 files changed

+147
-0
lines changed

CODE-OF-CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project leader at [jeff@jeffreyfritz.com](mailto:jeff@jeffreyfritz.com). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to InstantAPIs
2+
3+
Thank you for taking the time to consider contributing to our project.
4+
5+
The following is a set of guidelines for contributing to the project. These are mostly guidelines, not rules, and can be changed in the future. Please submit your suggestions with a pull-request to this document.
6+
7+
1. [Code of Conduct](#code-of-conduct)
8+
1. [What should I know before I get started?](#what-should-i-know-before-i-get-started?)
9+
1. [Project Folder Structure](#project-folder-structure)
10+
1. [Design Decisions](#design-decisions)
11+
1. [How can I contribute?](#how-can-i-contribute?)
12+
1. [Work on an Issue in the project](#work-on-an-issue-in-the-project)
13+
1. [Report a Bug](#report-a-bug)
14+
1. [Write documentation](#write-documentation)
15+
16+
17+
## Code of Conduct
18+
19+
We have adopted a [code of conduct](https://github.com/csharpfritz/InstantAPIs/blob/main/CODE-OF-CONDUCT) from the Contributor Covenant. Contributors to this project are expected to adhere to this code. Please report unwanted behavior to [jeff@jeffreyfritz.com](mailto:jeff@jeffreyfritz.com)
20+
21+
## What should I know before I get started?
22+
23+
This project is currently a proof-of-concept library that generates Minimal API endpoints for an Entity Framework context.
24+
### Project Folder Structure
25+
26+
The folders are a basic structure which will change as needed to support the project as it grows. The folders are configured as follows:
27+
28+
```
29+
30+
Fritz.InstantAPIs The project code.
31+
WorkingApi The project to test the functionality being developed.
32+
33+
```
34+
35+
### Design Decisions
36+
37+
Design for this project is ultimately decided by the project lead, [Jeff Fritz](https://github.com/csharpfritz). The following project tenets are adhered to when making decisions:
38+
39+
## How can I contribute?
40+
41+
We are always looking for help on this project. There are several ways that you can help:
42+
43+
#### Tool suggestions for contributing
44+
45+
1. [Visual Studio](https://visualstudio.microsoft.com/) (Windows)
46+
2. [Visual Studio Code](https://visualstudio.microsoft.com/) (Windows, Linux, Mac)
47+
3. [Visual Studio For Mac](https://visualstudio.microsoft.com/)
48+
4. Any text editor (Windows, Linux, Mac)
49+
5. Any Web browser.
50+
51+
#### Work on an Issue in the project
52+
53+
1. [Work on an Issue](https://github.com/csharpfritz/InstantAPIs/issues) Choose an Issue that you are interested in working on follow the instruction provided in the link below. We thank you in advance for your contributions.
54+
55+
#### Report a Bug
56+
57+
1. [Report a Bug](https://github.com/csharpfritz/InstantAPIs/issues) with the details of a bug that you have found. Be sure to tag it as a `Bug` so that we can triage and track it.
58+
59+
#### Write documentation
60+
61+
We are always looking for help to add content to the project.
62+
63+
#### Recources
64+
65+
[cmjchrisjones Blog: Contributing To Someone else's git repository](https://cmjchrisjones.dev/posts/contributing-to-someone-elses-git-repository/)

Fritz.InstantAPIs.sln

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Workflows", "Workflows", "{
1212
.github\workflows\build.yaml = .github\workflows\build.yaml
1313
EndProjectSection
1414
EndProject
15+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C73968E9-8A12-401C-BA5D-127C6D5A55D6}"
16+
ProjectSection(SolutionItems) = preProject
17+
CODE-OF-CONDUCT.md = CODE-OF-CONDUCT.md
18+
CONTRIBUTING.md = CONTRIBUTING.md
19+
EndProjectSection
20+
EndProject
1521
Global
1622
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1723
Debug|Any CPU = Debug|Any CPU

0 commit comments

Comments
 (0)