erika.florist
Rust library to generate static websites
misc: license & md files & github templates & labels (#9)
* misc: license & md files & github templates & labels
* Update .github/ISSUE_TEMPLATE/01-bug-report.yml
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
* Update .github/labeler.yml
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
* Update .github/workflows/label.yml
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
* Update CONTRIBUTING.md
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
* Bruits
---------
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
authored by
Goulven CLEC'H
Erika
and committed by
GitHub
c2f8b560
82133a62
+36
.github/ISSUE_TEMPLATE/01-bug-report.yml
+36
.github/ISSUE_TEMPLATE/01-bug-report.yml
···
1
+
name: "Bug Report"
2
+
description: Report an issue or possible bug
3
+
labels: []
4
+
assignees: []
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
## Quick Checklist
10
+
Thank you for taking the time to file a bug report! Please fill out this form as completely as possible. If you're not sure how to fill out a section, do your best and we'll help you along the way.
11
+
- type: textarea
12
+
id: bug-version
13
+
attributes:
14
+
label: Version
15
+
description: Provide the version of Maudit and any relevant dependencies you are using
16
+
- type: textarea
17
+
id: bug-description
18
+
attributes:
19
+
label: Describe the Bug
20
+
description: A clear and concise description of what the bug is.
21
+
validations:
22
+
required: true
23
+
- type: textarea
24
+
id: bug-expectation
25
+
attributes:
26
+
label: What's the expected result?
27
+
description: Describe what you expect to happen.
28
+
validations:
29
+
required: true
30
+
- type: checkboxes
31
+
id: will-pr
32
+
attributes:
33
+
label: Participation
34
+
options:
35
+
- label: I am willing to submit a pull request for this issue.
36
+
required: false
+11
.github/ISSUE_TEMPLATE/config.yml
+11
.github/ISSUE_TEMPLATE/config.yml
···
1
+
blank_issues_enabled: false
2
+
contact_links:
3
+
- name: Any ideas or suggestions?
4
+
url: https://github.com/bruits/maudit/discussions/categories/ideas
5
+
about: Propose and discuss future improvements to Maudit (and Oubli).
6
+
- name: Support or help needed? (GitHub)
7
+
url: https://github.com/bruits/maudit/discussions/categories/q-a
8
+
about: Ask questions and get help from the community.
9
+
- name: Support or help needed? (Discord)
10
+
url: https://maudit.org/chat/
11
+
about: Ask questions and get help from the community.
+14
.github/PULL_REQUEST_TEMPLATE.md
+14
.github/PULL_REQUEST_TEMPLATE.md
···
1
+
Fixes # <!-- Add the issue number here -->
2
+
3
+
## What does this change?
4
+
5
+
- Be short and concise. Bullet points can help!
6
+
- Before/after screenshots can help as well.
7
+
8
+
## How is it tested?
9
+
10
+
<!-- DON'T DELETE THIS SECTION! If no tests added, explain why. -->
11
+
12
+
## How is it documented?
13
+
14
+
<!-- DON'T DELETE THIS SECTION! If no docs added, explain why.-->
+34
.github/labeler.yml
+34
.github/labeler.yml
···
1
+
# See https://github.com/actions/labeler
2
+
website:
3
+
- changed-files:
4
+
- any-glob-to-any-file: website/**
5
+
6
+
examples:
7
+
- changed-files:
8
+
- any-glob-to-any-file: examples/**
9
+
10
+
"crt:maudit":
11
+
- changed-files:
12
+
- any-glob-to-any-file: crates/framework/**
13
+
14
+
"crt:cli":
15
+
- changed-files:
16
+
- any-glob-to-any-file: crates/cli/**
17
+
18
+
"crt:macros":
19
+
- changed-files:
20
+
- any-glob-to-any-file: crates/macros/**
21
+
22
+
"crt:benchmarks":
23
+
- changed-files:
24
+
- any-glob-to-any-file: crates/md-benchmarks/**
25
+
26
+
devops:
27
+
- changed-files:
28
+
- any-glob-to-any-file:
29
+
- .github/**
30
+
- .vscode/**
31
+
- .zed/**
32
+
- .editorconfig
33
+
- .gitignore
34
+
- justfile
+18
.github/workflows/label.yml
+18
.github/workflows/label.yml
···
1
+
# Automatically labels PRs based on the configuration file
2
+
# you are probably looking for 👉 `.github/labeler.yml`
3
+
name: "Pull Request Labeler"
4
+
on:
5
+
- pull_request_target
6
+
7
+
jobs:
8
+
labeler:
9
+
permissions:
10
+
contents: read
11
+
pull-requests: write
12
+
runs-on: ubuntu-latest
13
+
if: github.repository_owner == 'bruits'
14
+
steps:
15
+
- uses: actions/labeler@v5
16
+
with:
17
+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
18
+
sync-labels: true
+128
CODE_OF_CONDUCT.md
+128
CODE_OF_CONDUCT.md
···
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, religion, or sexual identity
10
+
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
26
+
overall community
27
+
28
+
Examples of unacceptable behavior include:
29
+
30
+
* The use of sexualized language or imagery, and sexual attention or
31
+
advances of 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
35
+
address, 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
+
princesseuh@proton.me or goulven.clech@protonmail.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
86
+
of 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
93
+
permanent 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
113
+
the community.
114
+
115
+
## Attribution
116
+
117
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+
version 2.0, available at
119
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+
enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+
[homepage]: https://www.contributor-covenant.org
125
+
126
+
For answers to common questions about this code of conduct, see the FAQ at
127
+
https://www.contributor-covenant.org/faq. Translations are available at
128
+
https://www.contributor-covenant.org/translations.
+25
CONTRIBUTING.md
+25
CONTRIBUTING.md
···
1
+
# Contributing to Our Open Source Projects
2
+
3
+
First, a huge **thank you** for dedicating your time to helping us improve our projects 🧡
4
+
5
+
## Before Opening Issues
6
+
7
+
- **Do not report security vulnerabilities publicly** (e.g., in issues or discussions), please refer to our [security policy](https://github.com/bruits/maudit/blob/main/SECURITY.md).
8
+
- **Do not create issues for ideas or suggestions.** Instead, share your thoughts in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/ideas).
9
+
- **Do not create issues for questions.** Instead, ask your question in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/q-a) or on [our Discord](https://maudit.org/chat).
10
+
- **Check for duplicates.** Look through existing issues and discussions to see if your topic has already been addressed.
11
+
- Provide as much detail as possible. However, don’t worry if it’s incomplete—we will help refine it!
12
+
13
+
## Before submitting Pull Requests (PRs)
14
+
15
+
- **Check for duplicates.** Look through existing PRs to see if your changes have already been submitted.
16
+
- **Avoid trivial changes.** Don't submit PRs for typos, grammar, or insignificant changes, as they will be **declined** without review.
17
+
- PRs don't need to be perfect. Submit your best effort, and we will gladly assist in polishing the work.
18
+
19
+
## Code of Conduct
20
+
21
+
We’re committed to fostering a welcoming and respectful community. Any issue, PR, or discussion that violates our [code of conduct](https://github.com/bruits/maudit/blob/main/CODE_OF_CONDUCT.md) will be deleted, and the authors will be **banned**.
22
+
23
+
---
24
+
25
+
Thank you once again for contributing, we deeply appreciate all contributions, no matter how small or big.
+21
LICENSE
+21
LICENSE
···
1
+
MIT License
2
+
3
+
Copyright (c) 2024 Bruits
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+38
SECURITY.md
+38
SECURITY.md
···
1
+
# Security Policy
2
+
3
+
## Supported Versions
4
+
5
+
The following versions of our projects are currently supported with security updates:
6
+
7
+
| Package | Version | Supported |
8
+
| ------- | ------- | ------------------ |
9
+
| Maudit | 0.x.x | :white_check_mark: |
10
+
| Oubli | 0.x.x | :white_check_mark: |
11
+
12
+
## What is a Security Vulnerability?
13
+
14
+
A security vulnerability is a flaw or weakness in a system's design, implementation, operation, or management that could be exploited to violate the system's security policy. (Source: OWASP)
15
+
16
+
Please note that we will not accept reports related to vulnerabilities in other software, such as dependencies. Additionally, we reserve the right to close reports that describe scenarios deemed highly unlikely or far-fetched.
17
+
18
+
## Reporting a Vulnerability
19
+
20
+
We take security issues very seriously. If you discover a vulnerability, please report it through our private reporting form: [Report a Security Vulnerability](https://github.com/bruits/maudit/security/advisories/new).
21
+
22
+
### Guidelines for Reporting
23
+
24
+
- Do **not** report vulnerabilities publicly via issues or discussions.
25
+
- Please provide as much detail as possible about the vulnerability to help us investigate and resolve it quickly.
26
+
27
+
### What to Expect
28
+
29
+
- You will receive an acknowledgement of your report within **48 hours** (working days).
30
+
- If the report is valid, in most cases, a fix will be published within **one week** of confirming the vulnerability.
31
+
32
+
Keep in mind that we are an open-source project, and our team is composed of volunteers. We will do our best to address the issue promptly, but we appreciate your understanding and patience.
33
+
34
+
### Post-Fix Communication
35
+
36
+
Once the fix is deployed, a **public security advisory** will be published here: [Security Advisories](https://github.com/bruits/maudit/security/advisories). If applicable, credit will be given to the reporter for their responsible disclosure.
37
+
38
+
We greatly appreciate your efforts to help us maintain the security of our projects.