Skip to content

Commit

Permalink
Add Bootstrap and fix error handling, and add code of conduct.
Browse files Browse the repository at this point in the history
  • Loading branch information
ZandercraftGames committed Sep 27, 2023
1 parent 9dc5bea commit 9d49cc8
Show file tree
Hide file tree
Showing 10 changed files with 11,422 additions and 22 deletions.
95 changes: 95 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Code of Conduct - TechnicFlux
All maintainers and contributors of the TechnicFlux project are expected to follow this code of conduct within the
context(s) described in [Scope](#scope).

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make
participation in our project and our community a harassment-free experience for everyone and to consider everyone's
opinions, contributions, and feedback in an objective manner.

## Our Standards

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

* Demonstrating understanding and kindness toward other people
* Being respectful of differing opinions and viewpoints
* 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:

* Trolling, insulting or derogatory comments, and personal attacks
* Public or private harassment
* Publishing others' private information without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting


## Our Responsibilities

Project maintainers 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, or harmful.

Project maintainers 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 [security@zandercraft.ca](mailto:security@zandercraft.ca). 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, sustained inappropriate behavior,
harassment or aggression toward an individual, destruction of community resources, or malicious/illegal activity.

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

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/).
64 changes: 58 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,58 @@
# Contribution Guidelines
Thank you so much taking the time to contribute! ❤️

Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any
contributions you make are **greatly appreciated**. Our goal as a project is to be open to feedback and contributions,
fostering an active community in which you can truly be involved in improving TechnicFlux and keeping it bug-free.

> If you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support
> the project and show your appreciation:
> - ⭐ Star the project
> - 💬 Tweet about/share it
> - 📜 Refer to TechnicFlux in your own project/modpack's description
> - 🗣️ Tell your friends about TechnicFlux
## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Creating A Pull Request](#creating-a-pull-request)

## Code of Conduct

This project and everyone participating in it are governed by the
[TechnicFlux Code of Conduct](./CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to [security@zandercraft.ca](mailto:security@zandercraft.ca).

## I Have a Question

> If you want to ask a question, we assume that you have read all available [Documentation](https://github.com/Zandercraft/TechnicFlux/wiki).
Before you ask a question, it is best to search for existing [Issues](https://github.com/Zandercraft/TechnicFlux/issues)
that might help you. In case you have found a suitable issue and still need clarification, you can write your question
in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/Zandercraft/TechnicFlux/issues/new).
- Provide as much context as you can about your issue.
- Make sure to fill out all required fields in the template.

We will then take care of the issue as soon as possible.

## I Want To Contribute

> ### Legal Notice
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the
> necessary rights to the content and that the content you contribute may be provided under the project license.
>
> ### ⚠️ Security Issues
> You must never report security-related issues, vulnerabilities or bugs including sensitive information to the issue
> tracker, or elsewhere in public. Instead, see [SECURITY.md](./SECURITY.md) for instructions on reporting this type of
> issue.
* If you have suggestions for adding or removing features, feel free to [open an issue](https://github.com/Zandercraft/TechnicFlux/issues/new)
to discuss it, or directly [create a pull request](#creating-a-pull-request).
* Please make sure you check your spelling and grammar.
Expand All @@ -12,15 +63,16 @@ fostering an active community in which you can truly be involved in improving Te
* Use new branches on your fork to separate different changes _(see [Creating A Pull Request](#creating-a-pull-request))_.

### Creating A Pull Request
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes w/ Descriptive Message (`git commit -m 'Added AmazingFeature...'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a New Pull Request

> When naming your forks, please prefix your fork names with the type of change they include:
> **Bug Fixes** - `bugfix/`
> **New Features** - `feature/`
> **Removed Features** - `removal/`
> **Deprecations** - `deprecation/`
> **Project-Related Changes** - `project/` _includes grammar, document changes, GitHub actions, etc._
> _This makes it much easier to distinguish the purpose of a branch by its name._
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes w/ Descriptive Message (`git commit -m 'Added AmazingFeature...'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a New Pull Request
> _This makes it much easier to distinguish the purpose of a branch by its name._
Binary file modified README.md
Binary file not shown.
4 changes: 2 additions & 2 deletions app.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ app.use(function (req, res, next) {
})

// error handler
app.use(function (err, req, res) {
app.use(function (err, req, res, next) {

Check warning on line 31 in app.js

View workflow job for this annotation

GitHub Actions / Qodana for JS

Unused local symbol

Unused parameter next
// set locals, only providing error in development
res.locals.message = err.message
res.locals.error = req.app.get('env') === 'development' ? err : {}

// render the error page
res.status(err.status || 500)
res.render('error')
res.render('error', {title: `Error ${err.status}: ${err.message}`})
})

module.exports = app
12 changes: 12 additions & 0 deletions public/stylesheets/bootstrap-light.min.css

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions public/stylesheets/bootstrap.min.css

Large diffs are not rendered by default.

Loading

0 comments on commit 9d49cc8

Please sign in to comment.