Skip to content

Commit c9b2954

Browse files
MaximilianPfitzenmaierMaximilianPfitzenmaier
committed
init v1.0.0
1 parent 67b7776 commit c9b2954

File tree

6 files changed

+219
-4
lines changed

6 files changed

+219
-4
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Code of Conduct
2+
The goal is to create a community that is open and welcoming to all individuals.
3+
To achieve this, we have developed a code of conduct that outlines the expectations for behavior of all members of our community.
4+
5+
## Pledge
6+
This community is founded on respect and understanding.
7+
All members are expected to treat others with respect and empathy, and to not tolerate any form of discrimination,
8+
harassment, or attacks.
9+
10+
## Expectations
11+
Examples of behavior that contributes to creating a positive environment include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior by participants include:
20+
21+
- The use of sexualized language or imagery and sexual attention or advances
22+
- Trolling, insulting/derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Responsibilities
28+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate
29+
and fair corrective action in response to any instances of unacceptable behavior.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
32+
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily
33+
or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
34+
35+
## Contact
36+
If you feel uncomfortable or believe that someone has violated the code of conduct, p
37+
lease contact us at [your_email](mailto:your_email).
38+
We will thoroughly investigate the incident and aim for the best possible outcome.

‎CONTRIBUTING.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing Guide
2+
We welcome contributions from the community!
3+
If you would like to participate in the project, here are some things to consider.
4+
5+
## Code of Conduct
6+
Please read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
7+
8+
## Submission Guidelines
9+
10+
### Submitting an Issue
11+
Before starting work on a pull request, please check if there is an open issue that your contribution relates to.
12+
If there is no such issue, please create a new issue to describe your contribution and start the discussion.
13+
14+
### Submitting a Pull Request (PR)
15+
When you are ready to submit your contribution, please create a pull request.
16+
Here are some things to consider:
17+
18+
- Add a descriptive title to the pull request.
19+
- Link the related issue in the pull request.
20+
- Ensure that all tests are successful and no warnings occur.
21+
- Use a descriptive commit message.
22+
23+
## Workflow
24+
25+
- Find an issue that you would like to work on or create a new issue to propose a new feature or improvement.
26+
- Fork the repository on GitHub.
27+
- Create a new branch for your changes.
28+
- Make your changes and commit them to your branch.
29+
- Push your branch to your fork on GitHub.
30+
- Create a new pull request from your branch.
31+
32+
A maintainer will review your pull request and may ask you to make additional changes
33+
or provide more information before it is merged.
34+
35+
## License
36+
By submitting a contribution, you agree to have your contribution published under the project's license.
37+
Please make sure you have the right to submit your contribution under this license.
38+
39+
## Acknowledgements
40+
Thank you for wanting to contribute to the project! We appreciate the effort and time you are putting into your contribution.

‎LICENSE‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Maximilian Pfitzenmaier
3+
Copyright (c) 2023 YOUR_NAME
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

‎README.md‎

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
1-
# basic-repo-files
2-
Basic Reposititory Template Files such as README, CODE_OF_CONDUCT_ SECURITY and CONTRIBUTING
1+
# Basic Repository Files
2+
3+
This Repository provides some basic files you can use in your Projects
4+
5+
## Philosophy
6+
7+
Easy to use Templates for your GitHub Projects.
8+
9+
---
10+
11+
## Contents
12+
13+
- [Basic Repository Files](#basic-repository-files)
14+
- [Philosophy](#philosophy)
15+
- [Contents](#contents)
16+
- [Usage](#usage)
17+
- [The Files](#the-files)
18+
- [Configuration](#configuration)
19+
- [How to configure CODE\_OF\_CONDUCT](#how-to-configure-code_of_conduct)
20+
- [How to configure README](#how-to-configure-readme)
21+
- [How to configure SECURITY](#how-to-configure-security)
22+
- [License](#license)
23+
24+
25+
## Usage
26+
27+
### The Files
28+
29+
I provide you some basic Templates:
30+
* CODE_OF_CONDUCT.md
31+
* CONTRIBUTING.md
32+
* LICENSE
33+
* README.md
34+
* SECURITY
35+
36+
Keep in mind that you use this files on your own risk. These files are just some basic templates!
37+
38+
## Configuration
39+
40+
### How to configure CODE_OF_CONDUCT
41+
Change **your_email** to your real email
42+
43+
### How to configure README
44+
You can use this file as a starting Template or inspiration for you project.
45+
You can also find some markdown examples on the bottom of the file to customize your README
46+
47+
### How to configure SECURITY
48+
Change **your_email** to your real email
49+
50+
## License
51+
Published under [MIT License](./LICENSE).

‎README_PLAIN.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Project Name
2+
3+
Short Description of the Repository
4+
5+
## Philosophy
6+
7+
Describe the Philosophy of the project
8+
9+
---
10+
11+
## Contents
12+
13+
- [Project Name](#project-name)
14+
- [Philosophy](#philosophy)
15+
- [Contents](#contents)
16+
- [Requirements](#requirements)
17+
- [Host setup](#host-setup)
18+
- [Docker Desktop](#docker-desktop)
19+
- [Windows](#windows)
20+
- [macOS](#macos)
21+
- [Usage](#usage)
22+
- [Bringing up the stack](#bringing-up-the-stack)
23+
- [Configuration](#configuration)
24+
- [How to configure **FILENAME**](#how-to-configure-filename)
25+
- [How to execute commands on the cosole](#how-to-execute-commands-on-the-cosole)
26+
- [License](#license)
27+
28+
## Requirements
29+
30+
### Host setup
31+
32+
Pre-Requirements
33+
34+
### Docker Desktop
35+
36+
#### Windows
37+
38+
How is the Workflow for Windows users
39+
40+
#### macOS
41+
42+
How is the Workflow for Mac users
43+
44+
## Usage
45+
46+
### Bringing up the stack
47+
48+
Descripe how to start the stack
49+
* clone
50+
* spin up
51+
* shutdown
52+
53+
## Configuration
54+
55+
### How to configure **FILENAME**
56+
Descripe how you can change some files
57+
58+
## How to execute commands on the cosole
59+
60+
Can you execute commands on the CLI
61+
62+
63+
## License
64+
Published under [MIT License](./LICENSE).
65+
66+
[Refernce_Name]: https:/link-to-refernce/
67+
68+
> [!NOTE]
69+
> This is a Note
70+
71+
> ![WARNING]
72+
> This is a Warning
73+
74+
```sh
75+
// This is a shell
76+
```
77+
78+
```console
79+
console output ...
80+
```
81+
82+
`commands `
83+
84+
**bold text**

‎SECURITY.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Security Policy
2+
## Reporting a Vulnerability
3+
4+
If you discover a security vulnerability regarding this project, please e-mail me to [your_email](mailto:your_email)!

0 commit comments

Comments
 (0)