-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
1,303 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
|
||
# Contributing | ||
|
||
## Workflow | ||
|
||
1. Fork and clone this repository. | ||
2. Create a new branch in your fork based off the **main** branch. | ||
3. Make your changes. | ||
4. Commit your changes, and push them. | ||
5. Submit a Pull Request! | ||
|
||
## Contributing to the code | ||
|
||
**The issue tracker is only for issue reporting or proposals/suggestions. If you have a question, you can find us in our | ||
[Discord Server][discord server]**. | ||
|
||
To contribute to this repository, feel free to create a new fork of the repository and submit a pull request. We highly | ||
suggest [ESLint] to be installed in your text editor or IDE of your choice to ensure builds from GitHub Actions do not | ||
fail. | ||
|
||
**_Before committing and pushing your changes, please ensure that you do not have any linting errors by running | ||
`yarn lint`!_** | ||
|
||
### Birthdayy Concept Guidelines | ||
|
||
There are a number of guidelines considered when reviewing Pull Requests to be merged. _This is by no means an | ||
exhaustive list, but here are some things to consider before/while submitting your ideas._ | ||
|
||
- Everything in Birthdayy should be generally useful for the majority of users. Don't let that stop you if you've got a | ||
good concept though, as your idea still might be a great addition. | ||
- Everything should be shard compliant. If code you put in a pull request would break when sharding, break other things | ||
from supporting sharding, or is incompatible with sharding; then you will need to think of a way to make it work with | ||
sharding in mind before the pull request will be accepted and merged. | ||
- Everything should follow [OOP paradigms][oop paradigms] and generally rely on behaviour over state where possible. | ||
This generally helps methods be predictable, keeps the codebase simple and understandable, reduces code duplication | ||
through abstraction, and leads to efficiency and therefore scalability. | ||
- Everything should follow our ESLint rules as closely as possible, and should pass lint tests even if you must disable | ||
a rule for a single line. | ||
- Scripts that are to be ran outside of the scope of the bot should be added to a `scripts` directory at the root and | ||
should be in the `.mjs` file format. | ||
|
||
<!-- Link Dump --> | ||
|
||
[discord server]: https://birthdayy.xyz/discord | ||
[eslint]: https://eslint.org/ | ||
[node.js]: https://nodejs.org/en/download/ | ||
[yarn]: https://yarnpkg.com/getting-started/install | ||
[oop paradigms]: https://en.wikipedia.org/wiki/Object-oriented_programming |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
name: Bug Report | ||
description: File a bug report here | ||
title: 'bug: ' | ||
labels: ['bug:unverified'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: checkboxes | ||
id: new-bug | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Description of the bug | ||
description: Tell us what bug you encountered and what should have happened | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: steps-to-reproduce | ||
attributes: | ||
label: Steps To Reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
Please tell us how to reproduce this bug, for example: | ||
1. Write '...' | ||
2. Click on '...' | ||
3. See error | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected behavior | ||
description: What should be the expected behavior. | ||
placeholder: A clear and concise description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Screenshots | ||
description: If applicable, add screenshots to help explain your problem. | ||
placeholder: Paste your screenshots here. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Do you want to share any additional context about this bug? | ||
placeholder: Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Discord server | ||
url: https://discord.birthdayy.xyz | ||
about: Please visit our Discord server for questions and support requests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: 'request: ' | ||
labels: ['feature'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Thank you for suggesting this feature! The more information you provide, the more likely it is that it will be picked up. | ||
- type: checkboxes | ||
id: new-bug | ||
attributes: | ||
label: Is there an existing issue or pull request for this? | ||
description: Please search to see if an issue or pull request already exists for the feature you desire. | ||
options: | ||
- label: I have searched the existing issues and pull requests | ||
required: true | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Feature description | ||
description: Is your feature request related to a problem? Please describe. | ||
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: steps-to-reproduce | ||
attributes: | ||
label: Desired solution | ||
description: Describe the solution you'd like | ||
placeholder: A clear and concise description of what you want to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Alternatives considered | ||
description: Describe alternatives you've considered | ||
placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Do you want to share any additional context about this bug? | ||
placeholder: Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Security Policy | ||
|
||
## Reporting a Vulnerability | ||
|
||
If you find a vulnerability in Birthdayy Project codebase please report it immediately. If you deem the vulnerability | ||
exploitable by any users in any shape or form please join the Discord server at https://birthdayy.xyz/discord and let | ||
anyone with the "Developers" or "Collaborators" role know. In case the vulnerability is not exploitable by any users you | ||
are free to either: | ||
|
||
- Use the GitHub issue tracker to report the issue | ||
- or join the Discord server through https://birthdayy.xyz/discord and use the "#ticket" channel. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"$schema": "https://docs.renovatebot.com/renovate-schema.json", | ||
"extends": ["github>sapphiredev/readme:sapphire-renovate"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Dependencies | ||
node_modules/ | ||
.pnp/ | ||
package-lock.json | ||
|
||
# Yarn files | ||
.yarn/install-state.gz | ||
.yarn/build-state.yml | ||
|
||
# misc | ||
.DS_Store | ||
Thumbs.db | ||
|
||
# Local env vars | ||
.env | ||
|
||
# IDE Settings | ||
.idea/ | ||
.vs/ | ||
|
||
# Log files | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
*.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.gitignore | ||
yarn.lock | ||
.prettierignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import sapphirePrettierConfig from '@sapphire/prettier-config'; | ||
|
||
export default { | ||
...sapphirePrettierConfig, | ||
overrides: [ | ||
...sapphirePrettierConfig.overrides, | ||
{ | ||
files: ['README.md', 'LICENSE.md', '.github/**/*.md', 'profile/README.md'], | ||
options: { | ||
tabWidth: 2, | ||
useTabs: false, | ||
printWidth: 120, | ||
proseWrap: 'always' | ||
} | ||
}, | ||
{ | ||
files: ['.github/CODEOWNERS'], | ||
options: { | ||
parser: 'yaml' | ||
} | ||
} | ||
] | ||
}; |
Oops, something went wrong.