Skip to content

Commit

Permalink
Beet rework (#285)
Browse files Browse the repository at this point in the history
  • Loading branch information
aksiome authored Dec 30, 2024
1 parent 29519f0 commit d573d34
Show file tree
Hide file tree
Showing 2,779 changed files with 29,444 additions and 32,989 deletions.
14 changes: 0 additions & 14 deletions .env.yml

This file was deleted.

3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
* text=auto
*.ipynb filter=strip-notebook-output

/.github export-ignore
/.vscode export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.mcwpack.yml export-ignore
.readthedocs.yml export-ignore
132 changes: 132 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[[email protected]](mailto:[email protected]).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributing to Bookshelf 🎉

Thank you for your interest in contributing to Bookshelf! Please refer to our [contribution documentation](https://docs.mcbookshelf.dev/en/latest/contribute/index.html) for detailed guidelines on how to contribute.

Your contributions make Bookshelf better, and we're excited to work together! 😊
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
custom: ["helloasso.com/associations/altearn/formulaires/3/en"]
custom: ["https://www.helloasso.com/associations/altearn/formulaires/6/en"]
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: "🐛 Bug report"
description: Report a reproducible bug for investigation.
labels:
- '🐛 Bug'
body:
- type: input
attributes:
label: Module
description: Specify the module where the bug occurred (e.g., block, health, ...).
validations:
required: true

- type: input
attributes:
label: Feature
description: Specify the feature related to the bug (e.g., get_block, set_max_health, ...).
validations:
required: true

- type: input
attributes:
label: Version
description: Specify the version of Bookshelf you are using.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: |
Describe what should happen under normal conditions:
- What is the expected output or behavior?
placeholder: |
Example:
- The command returns the correct result.
- The system behaves as described in the documentation.
validations:
required: true

- type: textarea
attributes:
label: Actual Behavior
description: |
Describe what happens instead of the expected behavior:
- Is there an error message or a malfunction?
- How does it differ from what is expected?
placeholder: |
Example:
- The command throws an unexpected error.
- The system behaves incorrectly or inconsistently.
validations:
required: true

- type: textarea
attributes:
label: Possible Fix
description: |
If you have a suggestion for a fix or a reason for the bug, please provide it here.
placeholder: |
Example:
- The issue may be caused by a missing dependency.
- Updating a block tag could resolve this.
validations:
required: false

- type: textarea
attributes:
label: Steps to Reproduce
description: |
Provide a step-by-step guide to help us replicate the issue:
1.
2.
3.
4.
placeholder: |
Example:
1. Call feature A with parameter X.
2. Call feature B and observe behavior Y.
validations:
required: false
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: ❓ Question
url: https://github.com/Gunivers/Bookshelf/discussions
url: https://github.com/mcbookshelf/Bookshelf/discussions
about: Please ask questions here.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "✨ Feature request"
description: Suggest a new feature or improvement.
labels:
- '✨ Feature'
body:
- type: input
attributes:
label: Feature Name
description: Choose a short and descriptive name for the feature.
validations:
required: true

- type: input
attributes:
label: Target Module
description: Specify the module where this feature should be added.
placeholder: block, health, ...
validations:
required: true

- type: textarea
attributes:
label: Feature Description
description: |
Provide a clear description of the feature:
- What functionality does it offer?
- Why is this feature important or useful?
placeholder: |
Example:
- Adds functionality for managing block states.
- Enhances performance for specific tasks.
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: Provide any extra information, references, or examples to clarify your request.
validations:
required: false
6 changes: 0 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/module-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "✨ Module request"
description: Suggest a new module.
labels:
- '✨ Module'
body:
- type: input
attributes:
label: Module Name
description: Choose a short and descriptive name for the module.
placeholder: block, health, ...
validations:
required: true

- type: textarea
attributes:
label: Description
description: |
Provide a detailed description of what this module would do:
- What problem does it solve?
- What key features and functionalities would it include?
placeholder: |
Example:
- A module to handle physics calculations and complex movements.
- A collection of small medieval house structures for building.
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: Provide any extra information, references, or examples to clarify your request.
validations:
required: false
6 changes: 0 additions & 6 deletions .github/ISSUE_TEMPLATE/other.md

This file was deleted.

16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: "📝 Other"
description: Submit any other suggestions, such as adding related tools to the documentation.
body:
- type: textarea
attributes:
label: Suggestion or Inquiry
description: |
Please describe your suggestion, request, or inquiry:
- What would you like to see added, improved, or clarified?
- Include any relevant tools, examples, or links if applicable.
placeholder: |
Example:
- Suggest adding a related tool to the documentation.
- Request an update for clearer documentation on a specific feature.
validations:
required: true
Loading

0 comments on commit d573d34

Please sign in to comment.