generated from nhcarrigan/template
feat: migrate from github
This commit is contained in:
31
docs/projects/we-love-hacktoberfest/contributing.md
Normal file
31
docs/projects/we-love-hacktoberfest/contributing.md
Normal file
@ -0,0 +1,31 @@
|
||||
# Contributing
|
||||
|
||||
In addition to our standard contribution guidelines, there are some extra notes for this project.
|
||||
|
||||
## Adding Tags
|
||||
|
||||
Tags are used to respond to frequently asked questions. New tags can be added to `/src/data/tags`, and should be added in alphabetical order by
|
||||
`name`.
|
||||
|
||||
Tags require the following properties:
|
||||
|
||||
- `name`: The name of the tag. This is used to trigger the tag with `hf.<name>`.
|
||||
- `content`: This is the main body of the tag. You can insert line breaks with `\n`.
|
||||
- `title`: This is the title of the tag, which **should take the form of a question**.
|
||||
- `aliases`: These serve as alternate names for triggering the tag.
|
||||
|
||||
## Adding Phrases to the Bot
|
||||
|
||||
To add new responses to the bot, navigate to the `src/data/phrases.ts` file. Within the array, add the phrases you'd like the bot to potentially respond with.
|
||||
|
||||
## Adding Hearts to the Bot
|
||||
|
||||
All of our hearts are generously provided by [Luke's DevHearts project](https://github.com/lukeocodes/dev-hearts). Before you add a heart to this project, you need to submit it there and have it approved. Be sure to follow their contributing guidelines!
|
||||
|
||||
Once your heart is approved and merged, add the _name_ of your new heart file to the `src/data/hearts.ts` file - do _not_ include the file extension.
|
||||
|
||||
## Adding new users
|
||||
|
||||
To add a new user to respond to, navigate to the `src/data/loveData.ts` file. Create a new object with the corresponding data - if you are adding a corporate sponsor, exclude the `id` field.
|
||||
|
||||
Then, add a new array with the user's phrases in `src/data/phrases.ts`.
|
5
docs/projects/we-love-hacktoberfest/index.md
Normal file
5
docs/projects/we-love-hacktoberfest/index.md
Normal file
@ -0,0 +1,5 @@
|
||||
# We Love Hacktoberfest
|
||||
|
||||
This is a Discord bot built for the Hacktoberfest server. Originally intended to spread positivity for the stressed Hacktoberfest team in 2020, the bot has since been expanded to include a tag system for frequently asked questions.
|
||||
|
||||
[View the Code](https://github.com/nhcarrigan/we-love-hacktoberfest) | [View the Live App](https://discord.gg/hacktoberfest)
|
40
docs/projects/we-love-hacktoberfest/privacy.md
Normal file
40
docs/projects/we-love-hacktoberfest/privacy.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Privacy Policy
|
||||
|
||||
> [!DANGER]
|
||||
> In the spirit of open source, errors are logged publicly in our Discord community. These logs may include information relevant to the error in question.
|
||||
>
|
||||
> We encourage you to [join our Discord](https://chat.nhcarrigan.com) to see what is logged PRIOR to using our applications.
|
||||
|
||||
The use of this application is subject to this Privacy Policy. By using this application, you agree to the collection and use of your personal data in accordance with this Privacy Policy.
|
||||
|
||||
## Data Collected
|
||||
|
||||
In order to operate, the application collects and stores the following data:
|
||||
|
||||
- Discord User ID: The bot tracks your Discord user ID to associate database records with your user account.
|
||||
- Repository Name and Owner: The bot tracks the owner/name of repositories that are sent in the project sharing channel.
|
||||
- Timestamp: The bot tracks the last time your account shared a specific repository to determine if it is within the configured cool down.
|
||||
|
||||
## Right to Request Data
|
||||
|
||||
At any time, you may request a complete copy of your data stored by the application. Requests must be done via our [support server](https://chat.nhcarrigan.com) from the Discord account the data belongs to. This ensures that a user cannot impersonate you and request your data.
|
||||
|
||||
## Right to Removal
|
||||
|
||||
Due to the nature of the data collected and the necessity of data for functionality, removal may not be requested for this application.
|
||||
|
||||
## Right to Opt Out
|
||||
|
||||
You may opt out of data collection by refraining from sharing repository links in the configured project sharing channel.
|
||||
|
||||
## Data Retention
|
||||
|
||||
Data are stored for the minimum necessary time to ensure the application is able to function.
|
||||
|
||||
## Availability of Data
|
||||
|
||||
Data are available to members of the development team, for the express purpose of debugging, improving, and contributing to the application.
|
||||
|
||||
## Questions
|
||||
|
||||
Questions and concerns regarding this privacy policy may be directed to `privacy@nhcarrigan.com`.
|
3
docs/projects/we-love-hacktoberfest/self-hosting.md
Normal file
3
docs/projects/we-love-hacktoberfest/self-hosting.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Self Hosting
|
||||
|
||||
Instructions coming soon!
|
Reference in New Issue
Block a user