diff options
| -rw-r--r-- | CODE_OF_CONDUCT.md | 136 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 60 | ||||
| -rw-r--r-- | FAQ.md | 7 | ||||
| -rw-r--r-- | README.md | 1 |
4 files changed, 204 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..16b9495 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,136 @@ +<p align="center"> + <img src="src/assets/icons/512x512.png" width="200px"><br> + <a href="FAQ.md">FAQ</a> | + <a href="CONTRIBUTING.md">Contributing</a> | + <a href="https://github.com/0neGal/viper/releases">Releases</a><br> +</p> + +## Contributor 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 <a +href="mail:mail@0negal.com">mail@0negal.com</a> or <a +href="https://twitter.com/0neGal">@0neGal</a> on Twitter. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f514f06 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +<p align="center"> + <img src="src/assets/icons/512x512.png" width="200px"><br> + <a href="FAQ.md">FAQ</a> | + <a href="CONTRIBUTING.md">Contributing</a> | + <a href="https://github.com/0neGal/viper/releases">Releases</a><br> +</p> + +## Contributing + +Generally speaking, as Viper is a FOSS (GPLv3) project any bug reports, pull requests, or other types of help, forks are appreciated, but preferably unless it's off-topic to the goals of Viper, it would be far more appreciated if you were to make a pull request, or similar, and get it upstream. + +**HOWEVER:** Before opening issues and pull requests and similar, please do read our <a href="CODE_OF_CONDUCT.md">code of conduct</a>, as to avoid issues. + +### General contributions + +If you're contributing, please follow <a href="CODE_OF_CONDUCT.md">code of conduct</a> as mentioned above, along with that please do not change code style. Viper uses double quotes, 1 tab per indent, and semicolons at the end of function calls. + +`//` for 1-2 lines of comments, max of 72 comment text width always, preferably if textwidth outside of comments also exceeds 72 characters if possible find a way to make it fit within 72 characters. Lower case comments are also generally preferred when using `//` + +`/* */` is useful in some cases, refer to the code example below. + +`() => {}` is also preffered over `function () {}` when possible. + +Single use functions are also generally discouraged, if a function is used once there's no need to make it a function. + +As shown below below: + +```javascript +function foo(bar) { + /* + This is a very long comment, however, it does not exceed 72 + characters, and instead wraps down so it fits nicely on a small + screen without having to mess with soft-wrapping or similar. + */ + console.log(bar); + // and this is a comment using "//", + // which is two lines long +} + +// examples of () => {} +setInterval(() => { + foo("I RUN EVERY 1000MS"); +}, 1000) +``` + +With the above information you should be able to comfortably make contributions without too much hassle... + +### Localizing/Translating + +Viper has a very simple i18n system, please read below for instructions. + +#### Language file + +The language file will be a file inside the `src/lang/` folder, name it according to the [ISO 3166-1 Alpha-2 standard](https://en.m.wikipedia.org/wiki/ISO_3166-1_alpha-2) in lowercase, meaning English = en, Spanish = es, French = fr, and so on. + +Everything inside the file is pretty straight forward, the only special one is the `lang.title` string, please set this to `<language in english> - <language in native language>`, meaning for French it's, `French - Français`. This will be shown inside the language selection screen. + +#### Maintainers file + +If you're okay with being contacted in the future when new strings have to be localized please put your contact links inside this file, under your language. Preferably put the link to your GitHub profile as that is the easiest contact method for obvious reasons. @@ -1,3 +1,10 @@ +<p align="center"> + <img src="src/assets/icons/512x512.png" width="200px"><br> + <a href="FAQ.md">FAQ</a> | + <a href="CONTRIBUTING.md">Contributing</a> | + <a href="https://github.com/0neGal/viper/releases">Releases</a><br> +</p> + ## Frequently Asked Questions (FAQ) ### How do I install Viper? @@ -2,6 +2,7 @@ <img src="src/assets/icons/512x512.png" width="200px"><br> <a href="https://github.com/0neGal/viper/releases/download/v1.6.0/Viper-Setup-1.6.0.exe"><img src="assets/download.png" width="300px"></a><br> <a href="FAQ.md">FAQ</a> | + <a href="CONTRIBUTING.md">Contributing</a> | <a href="https://github.com/0neGal/viper/releases">Releases</a><br> </p> |