Skip to content

Commit e929b69

Browse files
committed
Fixed wrong rendering and abandoned the purple template text
1 parent 99c95f0 commit e929b69

File tree

3 files changed

+56
-17
lines changed

3 files changed

+56
-17
lines changed

MAINTAINERS.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Maintainers
2+
3+
This document provides information about the maintainers of the project, their roles, and how to engage with them.
4+
5+
## Current Maintainers
6+
7+
| Name | GitHub Username | Role/Responsibilities | Contact Method |
8+
|-----------------|----------------------|-----------------------------------------|-------------------------|
9+
| [Maintainer 1] | [@username1](https://github.com/username1) | [Role/Responsibility] | [[email protected]] |
10+
| [Maintainer 2] | [@username2](https://github.com/username2) | [Role/Responsibility] | [[email protected]] |
11+
| [Maintainer 3] | [@username3](https://github.com/username3) | [Role/Responsibility] | [[email protected]] |
12+
13+
## Emeritus Maintainers
14+
15+
| Name | GitHub Username | Role/Responsibilities | Contact Method |
16+
|-----------------|----------------------|-----------------------------------------|-------------------------|
17+
| [Emeritus 1] | [@emeritus1](https://github.com/emeritus1) | [Previous Role/Responsibility] | [[email protected]] |
18+
19+
## Becoming a Maintainer
20+
21+
To become a maintainer of this project, please follow these steps:
22+
23+
1. **Contribute**: Actively contribute to the project by submitting pull requests and participating in discussions.
24+
2. **Engagement**: Engage with the community and maintainers through issues and discussions.
25+
3. **Request**: Once you feel ready, request maintainer status by opening an issue or contacting an existing maintainer.
26+
27+
## Removal Process
28+
29+
Maintainers may be removed or moved to emeritus status under the following circumstances:
30+
31+
- Inactivity for an extended period (e.g., 6 months).
32+
- Failure to respond to issues or pull requests.
33+
- Request for removal by the maintainer.
34+
35+
Maintainers can be removed through a consensus among current maintainers.
36+
37+
---
38+
39+
*For any questions or concerns regarding maintainership, please reach out to any of the current maintainers listed above.*

CONTRIBUTING.md renamed to PROJECT_CONTRIBUTING_TEMPLATE.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@ Contributors to the documentation can be project managers, technical editors, de
44

55
To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of [Docs As Code](https://openpracticelibrary.com/practice/docs-as-code/) and the open [Markdown](https://en.wikipedia.org/wiki/Markdown) format for ease of collaboration and quality control.
66

7-
To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/).
8-
<br>
9-
<br>
7+
To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/).
8+
`<br>`
9+
`<br>`
1010

1111
## 🚀 Quick start
1212

1313
1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information.
1414
2. Follow the criteria from [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html), [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) and [Document codebase Maturity]()
15-
in one or several text documents using the Markdown format.
15+
in one or several text documents using the Markdown format.
1616
3. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
1717
4. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
1818
5. Collaborate on documentation branches with issues assigned to you by the maintainers.
1919

2020
> 📚 Read more about:
21-
>
22-
> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation
21+
>
22+
> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation
2323
> How [Just the Docs](https://just-the-docs.github.io/just-the-docs/) is used to generate a documentation site from your markdown files.
24-

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,42 @@
1-
> [!WARNING] Remove this section from your README.md after completing all setup tasks!
1+
> [!WARNING]
2+
> *Remove this section from your README.md after completing all setup tasks!*
23
> - [ ] Click the green "Use this template" button above.
34
> - [ ] Name your new repository and create it.
4-
> - [ ] Replace all the purple placeholder texts with your project-specific information.
5+
> - [ ] Replace all the grey placeholder texts with your project-specific information.
56
> - [ ] Add any additional relevant Markdown documents to your documentation.
67
> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
78
> - [ ] **Remove this setup section from your README.md.**
89
>
9-
> That's it! You are now set up, and your documentation site is live!
10+
> *That's it! You are now set up, and your documentation site is live!*
1011
1112

1213
# [Replace with Project Title]
13-
> [!IMPORTANT] [Replace with a clear statement defining the mission and goals of your project in simple terms.]
14+
> Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
1415
1516
[How It Works](#how-this-codebase-achieves-its-objectives) | [Project Architecture](#architecture) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Contact](#contact)
1617

1718

1819
## 🧭 How It Works
19-
> [!IMPORTANT]Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
20+
> Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
2021
2122
#### Architecture
2223

23-
> [!IMPORTANT] Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
24+
> Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
2425
2526
#### Key Features
2627

27-
> [!IMPORTANT] Replace this with a brief explaination of the main features or functionalities of your project.]
28+
> Replace this with a brief explaination of the main features or functionalities of your project.]
2829
2930

3031
## :arrow_heading_down: Installation
31-
> [!IMPORTANT] Replace with Step-by-step instructions on how to install the codebase.
32+
> Replace with Step-by-step instructions on how to install the codebase.
3233
3334
## ▶️ How to Run
34-
> [!IMPORTANT] Replace with clear, concise instructions on how to run and use the codebase.
35+
> Replace with clear, concise instructions on how to run and use the codebase.
3536
3637
#### Examples
3738

38-
> [!IMPORTANT] Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
39+
> Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
3940
4041
---
4142

0 commit comments

Comments
 (0)