Skip to content

Commit

Permalink
Community Standards (Astrabit-ST#63)
Browse files Browse the repository at this point in the history
* chore: Add a code of conduct

* chore: Start writing a basic style guide

* Add CODEOWNERS

* Update pull request and issue templates

* Update README.md and CONTRIBUTING.md

* Clarify what to do with the steamworks redistributable

* Oops forgot to add VX Ace section in FUNCTIONALITY.md

* Delete .markdownlint.json

* Remove mention of STYLE.md

* Rename compiler_error.md to be snake case

* Add conventional commit notice in CONTRIBUTING.md
  • Loading branch information
melody-rs authored Nov 23, 2023
1 parent d6619f3 commit 5e4cb1d
Show file tree
Hide file tree
Showing 8 changed files with 346 additions and 78 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @astrabit-st/luminol
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: somedevfox, Speak2Erase
assignees: ''

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Compiler error
about: Create a report of why luminol will not compile on a platform
title: "[COMPILER]"
labels: compiler
assignees: somedevfox, Speak2Erase
assignees: ''

---

Expand Down
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Connections**
_Link to the issues addressed by this PR, or dependent PRs in other repositories_

**Description**
_Describe what problem this is solving, and how it's solved._

**Testing**
_Explain how this change is tested._

<!--
Thanks for filing a pull request! The codeowners file will automatically request reviews.
After you get a review and have addressed any comments, please explicitly re-request a review from the
person(s) who reviewed your changes. This will make sure it gets re-added to their review queue - you're not bothering us!
-->

**Checklist**

- [ ] Run `cargo fmt`.
- [ ] Run `cargo clippy`. If applicable, add:
- [ ] `--target wasm32-unknown-unknown`
- [ ] Run `cargo build --release`
- [ ] If applicable, run `trunk build --release`
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 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, 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 e-mail 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]>.
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.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## How to contribute to Luminol

#### **Find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Astrabit-ST/Luminol/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Astrabit-ST/Luminol/issues/new). Be sure to include a **title and clear description** and a **test case** demonstrating the expected behavior that is not occurring.

* If possible, use the relevant bug report templates to create the issue.
* Try and provide a backtrace if possible.
* You can do this by piping Luminol's output into a file and causing the crash.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**

We do not generally accept these sorts of changes unless they substantially fix readability.

#### **Do you intend to add a new feature or change an existing one?**

* If you are adding a feature, check that it has not been suggested by searching on GitHub under [Issues](https://github.com/Astrabit-ST/Luminol/issues). If it hasn't, please open an issue for proper discussion.

* After there is a consensus on the new feature, you are free to make a pull request.

#### **Did you make a commit to the repository?**

As a general rule of thumb we use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. It's okay if you miss it occasionally though!

You can use the [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits) Visual Studio Code extension to automatically write conventional commit messages for you.

#### **Do you have questions about the source code?**

* Ask any question about code design in the [discord server](https://discord.gg/8jZKmesKJy).
108 changes: 108 additions & 0 deletions FUNCTIONALITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
## Functionality

### Common funtionality

- [x] Common event editor
- [x] Script editor
- [x] Sound test
- [x] Properly render blend modes and opacity

### RPG Maker XP

- [x] Load from rxdata
- [x] Load projects
- [x] Make new projects
- [ ] Create new maps
- [ ] Reorder maps
- [ ] Resize maps
- [x] Open events
- [ ] Edit event commands
- [x] View event commands
- [x] Change tiles on map
- [x] Multiple brush types
- [x] Change autotiles on map
- [x] Hardware accelerated tilemap
- [ ] Actor editor
- [ ] Class editor
- [ ] Skill editor
- [x] Item editor
- [ ] Weapon editor
- [ ] Armor editor
- [ ] Enemy editor
- [ ] Troop editor
- [ ] State editor
- [ ] Animation editor
- [ ] Tileset editor

### RPG Maker VX

- [ ] Load from rvdata
- [ ] Load projects
- [ ] Make new projects
- [ ] Create new maps
- [ ] Reorder maps
- [ ] Resize maps
- [ ] Open events
- [ ] Edit event commands
- [ ] View event commands
- [ ] Change tiles on map
- [ ] Multiple brush types
- [ ] Hardware accelerated tilemap
- [ ] Actor editor
- [ ] Class editor
- [ ] Skill editor
- [ ] Item editor
- [ ] Weapon editor
- [ ] Armor editor
- [ ] Enemy editor
- [ ] Troop editor
- [ ] State editor
- [ ] Animation editor
- [ ] Tileset editor
- [ ] System editor

### RPG Maker VX Ace

- [ ] Load from rvdata
- [ ] Load projects
- [ ] Make new projects
- [ ] Create new maps
- [ ] Reorder maps
- [ ] Resize maps
- [ ] Open events
- [ ] Edit event commands
- [ ] View event commands
- [ ] Change tiles on map
- [ ] Multiple brush types
- [ ] Hardware accelerated tilemap
- [ ] Actor editor
- [ ] Class editor
- [ ] Skill editor
- [ ] Item editor
- [ ] Weapon editor
- [ ] Armor editor
- [ ] Enemy editor
- [ ] Troop editor
- [ ] State editor
- [ ] Animation editor
- [ ] Tileset editor
- [ ] System editor

### Extra functionality

- [x] Edit multiple maps at the same time
- [x] Edit multiple events at the same time
- [x] Edit multiple scripts
- [ ] Language server support for script editor?
- [x] Custom event commands
- [x] Procedural event commands
- [ ] Debugger support?
- [ ] Custom data formats
- [ ] Extra layers
- [x] Move route previews
- [ ] r48 style raw manipulation of values
- [ ] Custom themes (sorta implemented)
- [ ] Styling different from egui's
- [ ] Lua plugin API?
- [ ] Text based event editor [based on keke](https://github.com/Astrabit-ST/keke)
- [ ] Extra properties
Loading

0 comments on commit 5e4cb1d

Please sign in to comment.