-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added files which have been removed my mistake
- Loading branch information
Showing
5 changed files
with
254 additions
and
0 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,94 @@ | ||
# Citizen Code of Conduct | ||
|
||
## 1. Purpose | ||
|
||
A primary goal of Nexus is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof). | ||
|
||
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior. | ||
|
||
We invite all those who participate in Nexus to help us create safe and positive experiences for everyone. | ||
|
||
## 2. Open [Source/Culture/Tech] Citizenship | ||
|
||
A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community. | ||
|
||
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society. | ||
|
||
If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know. | ||
|
||
## 3. Expected Behavior | ||
|
||
The following behaviors are expected and requested of all community members: | ||
|
||
* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. | ||
* Exercise consideration and respect in your speech and actions. | ||
* Attempt collaboration before conflict. | ||
* Refrain from demeaning, discriminatory, or harassing behavior and speech. | ||
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. | ||
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations. | ||
|
||
## 4. Unacceptable Behavior | ||
|
||
The following behaviors are considered harassment and are unacceptable within our community: | ||
|
||
* Violence, threats of violence or violent language directed against another person. | ||
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. | ||
* Posting or displaying sexually explicit or violent material. | ||
* Posting or threatening to post other people's personally identifying information ("doxing"). | ||
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. | ||
* Inappropriate photography or recording. | ||
* Inappropriate physical contact. You should have someone's consent before touching them. | ||
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances. | ||
* Deliberate intimidation, stalking or following (online or in person). | ||
* Advocating for, or encouraging, any of the above behavior. | ||
* Sustained disruption of community events, including talks and presentations. | ||
|
||
## 5. Weapons Policy | ||
|
||
No weapons will be allowed at Nexus events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives (including fireworks), and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter. | ||
|
||
## 6. Consequences of Unacceptable Behavior | ||
|
||
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. | ||
|
||
Anyone asked to stop unacceptable behavior is expected to comply immediately. | ||
|
||
If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event). | ||
|
||
## 7. Reporting Guidelines | ||
|
||
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. contact@toowake.dev. | ||
|
||
|
||
|
||
Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress. | ||
|
||
## 8. Addressing Grievances | ||
|
||
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. [Policy](https://nexus-hosting.tech/privacy-policy/) | ||
|
||
|
||
|
||
## 9. Scope | ||
|
||
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business. | ||
|
||
This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members. | ||
|
||
## 10. Contact info | ||
|
||
contact@toowake.dev | ||
|
||
## 11. License and attribution | ||
|
||
The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). | ||
|
||
Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). | ||
|
||
_Revision 2.3. Posted 6 March 2017._ | ||
|
||
_Revision 2.2. Posted 4 February 2016._ | ||
|
||
_Revision 2.1. Posted 23 June 2014._ | ||
|
||
_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._ |
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,69 @@ | ||
# Contributing to Nexus | ||
|
||
First off, thank you for considering contributing to Nexus! It's people like you that make this project such a great tool for Discord communities. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## I don't want to read this whole thing, I just have a question!!! | ||
|
||
Please don't file an issue to ask a question. You'll get faster results by using the community chat resources: | ||
|
||
- Join our [Discord Server](https://discord.gg/nexushosting) | ||
- Check out the [discord.js guide](https://discordjs.guide/) | ||
|
||
## What should I know before I get started? | ||
|
||
### Project Structure | ||
|
||
Our project uses discord.js v14, which means you should be familiar with modern JavaScript and Node.js. The main entry point of the bot is located in `index.js`, with commands and event handlers organized into separate directories. | ||
|
||
### Development Environment | ||
|
||
Ensure you have Node.js v16 or newer installed, as discord.js v14 requires it. Additionally, you'll need a Discord account and a test server to try out your changes. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you encounter a bug, please file an issue with a clear title and description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. | ||
|
||
### Suggesting Enhancements | ||
|
||
Enhancement suggestions are also welcome. Please include as many details as possible, with a focus on why the enhancement would be beneficial to Nexus. | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to Nexus? Look for 'good first issue' labels on our issue tracker. | ||
|
||
### Pull Requests | ||
|
||
1. Fork the repository and create your branch from `main`. | ||
2. Ensure you have tested your code. | ||
3. Update the README.md with details of changes, if applicable. | ||
4. Issue the pull request. | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
- Use the present tense ("Add feature" not "Added feature"). | ||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). | ||
- Limit the first line to 72 characters or less. | ||
- Reference issues and pull requests liberally after the first line. | ||
|
||
### JavaScript Styleguide | ||
|
||
All JavaScript must adhere to [Airbnb's JavaScript Style Guide](https://github.com/airbnb/javascript). | ||
|
||
### Documentation Styleguide | ||
|
||
- Use Markdown for documentation. | ||
- Document new code based on any changes. | ||
|
||
## Questions or Need Help? | ||
|
||
Feel free to contact us at [contact@toowake.dev] if you have any questions or need help. | ||
|
||
Thank you for your contributions to Nexus! |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2022 toowake | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,63 @@ | ||
# NEXUS | ||
|
||
Welcome to NEXUS, a project hosted by Toowake Development. | ||
|
||
[Quick Links](#quick-links) | [Getting Started](#getting-started) | [Terms of Service](#terms-of-service) | [Support Us](#support-us) | [Credits](#credits) | ||
|
||
## Quick Links | ||
|
||
- **Panel**: [Nexhost Panel](https://panel.toowake.host) | ||
- **Discord**: [Join Our Server](https://discord.gg/toowake) | ||
- **Website**: [Nexus Now (In Development)](https://toowake.live) | ||
- **Developer's Site**: [Toowake Development](https://toowake.dev) | ||
- **Leaderboard Beta**: [HERE](http://toowake.live:443/1121353922355929129/leaderboard) | ||
|
||
## Getting Started | ||
|
||
Before you begin, ensure the following: | ||
|
||
- A Discord bot ready. Create one at the [Discord Developer Portal](https://discord.com/developers). | ||
- Your bot listed on [top.gg](https://top.gg) and [Omen List](https://omenlist.xyz). | ||
- `.env` file filled out. Tutorial: [.env Tutorial](https://sites.google.com/view/nexusenv/). | ||
- Read the discord.js [Documentation](https://discord.js.org/docs). | ||
- Read the discord.js [Guide](https://discordjs.guide/) | ||
- Install every npm listed in [package.json](https://github.com/toowake/nexus/blob/main/package.json) | ||
|
||
## Update | ||
Info Point: | ||
- Added new help commands (new commands will be detected automatically) | ||
- Added new Autoreply command (one command - more options) | ||
- Audit Log remake | ||
- New Handler for Events (index.js has now less code) | ||
- Removed Blacklist System (next update will have it, i promise) | ||
- Better Error Handling (User Interaction Errors will be sent to your error channel) | ||
|
||
## Terms of Service | ||
|
||
- No unauthorized use of the Nexus Logo. | ||
- Code is free and not for sale. | ||
- Terms subject to change without notice. | ||
- Do not claim this code as your own. | ||
- Encouraged to keep bot services free. | ||
- Do not use our Terms and Privacy Policy for your bot. | ||
|
||
## Support Us | ||
|
||
<p align="center"> | ||
|
||
[](https://discord.gg/toowake) | ||
|
||
[](https://patreon.com/toowake) | ||
|
||
[](https://github.com/toowake) | ||
|
||
[](https://buymeacoffee.com/toowake) | ||
|
||
</p> | ||
|
||
## Credits | ||
Discord API Interaction - [discord.js](https://discord.js.org) <br> | ||
JavaScript runtime environment - [NodeJS](https://nodejs.org/en) <br> | ||
Code Editor - [Microsoft Visual Studio Code](https://code.visualstudio.com) <br> | ||
Live Share - [Microsoft Live Share](https://visualstudio.microsoft.com/de/services/live-share/) <br> | ||
Error Detection Tool - [Alexander Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens) |
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,7 @@ | ||
## Supported Discord.JS Versions | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| 12 | :x: | | ||
| 13 | :x: | | ||
| 14 | :white_check_mark: | |