generated from nhcarrigan/template
feat: time for another audit/overhaul/revamp (#13)
Node.js CI / Lint and Test (push) Successful in 1m56s
Node.js CI / Lint and Test (push) Successful in 1m56s
### Explanation _No response_ ### Issue Closes #11 ### Attestations - [ ] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/) - [ ] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). - [ ] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). ### Dependencies - [ ] I have pinned the dependencies to a specific patch version. ### Style - [ ] I have run the linter and resolved any errors. - [ ] My pull request uses an appropriate title, matching the conventional commit standards. - [ ] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. ### Tests - [ ] My contribution adds new code, and I have added tests to cover it. - [ ] My contribution modifies existing code, and I have updated the tests to reflect these changes. - [ ] All new and existing tests pass locally with my changes. - [ ] Code coverage remains at or above the configured threshold. ### Documentation _No response_ ### Versioning _No response_ Reviewed-on: #13 Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com> Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit was merged in pull request #13.
This commit is contained in:
@@ -12,11 +12,11 @@ export const navigation = [
|
|||||||
link: "/about/sustainability",
|
link: "/about/sustainability",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Hire us!",
|
label: "Professional Services and Commission Policy",
|
||||||
link: "/about/hire",
|
link: "/about/hire",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Support Our Work 💜",
|
label: "Donation and Support Policy",
|
||||||
link: "/about/donate",
|
link: "/about/donate",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -2,11 +2,25 @@
|
|||||||
title: Contact Policy
|
title: Contact Policy
|
||||||
---
|
---
|
||||||
|
|
||||||
## Introduction and Legal Framework
|
**ESTABLISHING COMMUNICATION STANDARDS AND CHANNELS FOR ORGANISATIONAL INTERACTIONS**
|
||||||
|
|
||||||
This Contact Policy establishes our communication standards, channels, and expectations for all interactions with our organisation. This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
**IMPORTANT: All communications are subject to our Limitation of Liability and Indemnification Policy, Community Code of Conduct, and applicable legal frameworks. By engaging in communication with us, you acknowledge and agree to comply with all relevant policies.**
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Contact Policy ("Policy") establishes our communication standards, channels, and expectations for all interactions with our organisation. This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Legal Framework Integration
|
||||||
|
|
||||||
|
**IMPORTANT: All communications are subject to our Limitation of Liability and Indemnification Policy, Community Code of Conduct, and applicable legal frameworks. By engaging in communication with us, you acknowledge and agree to comply with all relevant policies. Comprehensive warranty disclaimers and liability limitations are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 1.3. Scope of Application
|
||||||
|
|
||||||
|
This Policy applies to:
|
||||||
|
**(a)** All communications with NHCarrigan ("we," "us," "our," or "the Company");
|
||||||
|
**(b)** All communication channels, platforms, and methods used to contact our organisation;
|
||||||
|
**(c)** All support requests, inquiries, and interactions with our team;
|
||||||
|
**(d)** All public and private communication channels operated by our organisation.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -60,7 +74,7 @@ ssh-keygen -Y verify -f /path/to/saved/key -I naomi@nhcarrigan.com -n socials -s
|
|||||||
|
|
||||||
## 1. Support and Communication Channels
|
## 1. Support and Communication Channels
|
||||||
|
|
||||||
### 1.1 Public Support Channels
|
### 1.1. Public Support Channels
|
||||||
|
|
||||||
We offer FREE support through several PUBLIC channels, including:
|
We offer FREE support through several PUBLIC channels, including:
|
||||||
|
|
||||||
@@ -74,7 +88,7 @@ These channels are ideal for:
|
|||||||
- Community discussions and knowledge sharing
|
- Community discussions and knowledge sharing
|
||||||
- Open-source collaboration opportunities
|
- Open-source collaboration opportunities
|
||||||
|
|
||||||
### 1.2 Private Support Options
|
### 1.2. Private Support Options
|
||||||
|
|
||||||
While we encourage the use of public channels, we understand that some situations may require private communication. Please note:
|
While we encourage the use of public channels, we understand that some situations may require private communication. Please note:
|
||||||
|
|
||||||
@@ -85,7 +99,7 @@ While we encourage the use of public channels, we understand that some situation
|
|||||||
|
|
||||||
To request private support, please contact us through `support@nhcarrigan.com`.
|
To request private support, please contact us through `support@nhcarrigan.com`.
|
||||||
|
|
||||||
### 1.3 Engagement Opportunities
|
### 1.3. Engagement Opportunities
|
||||||
|
|
||||||
Our platforms offer various ways to engage with our projects and community:
|
Our platforms offer various ways to engage with our projects and community:
|
||||||
|
|
||||||
@@ -94,13 +108,13 @@ Our platforms offer various ways to engage with our projects and community:
|
|||||||
- Seek mentorship in software development
|
- Seek mentorship in software development
|
||||||
- Participate in casual discussions with our team and community members
|
- Participate in casual discussions with our team and community members
|
||||||
|
|
||||||
### 1.4 Contact Form
|
### 1.4. Contact Form
|
||||||
|
|
||||||
We offer a [contact form](https://forms.nhcarrigan.com/form/HyqoJ9Th5QDiOn_GPLNIRhe1a5ON7mDQf-O_ukM6R4g) for direct, low-priority communication requests.
|
We offer a [contact form](https://forms.nhcarrigan.com/form/HyqoJ9Th5QDiOn_GPLNIRhe1a5ON7mDQf-O_ukM6R4g) for direct, low-priority communication requests.
|
||||||
|
|
||||||
It is often faster to reach out through one of the below platforms, and best to consider this contact form as a backup in the event of a severe outage.
|
It is often faster to reach out through one of the below platforms, and best to consider this contact form as a backup in the event of a severe outage.
|
||||||
|
|
||||||
## 2. Communication Platforms
|
## 2. COMMUNICATION PLATFORMS
|
||||||
|
|
||||||
### 2.1. Discord
|
### 2.1. Discord
|
||||||
|
|
||||||
@@ -129,9 +143,9 @@ Our code repositories are all self-hosted. You will need to request an account v
|
|||||||
- Before asking a question, check if it has been answered in pinned messages or FAQs.
|
- Before asking a question, check if it has been answered in pinned messages or FAQs.
|
||||||
- When seeking help, provide as much relevant information as possible.
|
- When seeking help, provide as much relevant information as possible.
|
||||||
|
|
||||||
## 3. Announcements and Updates
|
## 3. ANNOUNCEMENTS AND UPDATES
|
||||||
|
|
||||||
### 3.1 Announcements Page
|
### 3.1. Announcements Page
|
||||||
|
|
||||||
We have a dedicated page where we post all of our organisational updates.
|
We have a dedicated page where we post all of our organisational updates.
|
||||||
|
|
||||||
@@ -144,7 +158,7 @@ We have a dedicated page where we post all of our organisational updates.
|
|||||||
- Major policy changes
|
- Major policy changes
|
||||||
- Best for: Comprehensive, detailed announcements and long-form updates
|
- Best for: Comprehensive, detailed announcements and long-form updates
|
||||||
|
|
||||||
### 3.2 Blog
|
### 3.2. Blog
|
||||||
|
|
||||||
Our blog contains more personal posts and updates.
|
Our blog contains more personal posts and updates.
|
||||||
|
|
||||||
@@ -156,17 +170,17 @@ Our blog contains more personal posts and updates.
|
|||||||
- Cool insights into our decision making processes
|
- Cool insights into our decision making processes
|
||||||
- Best for: People who want more insight into the team behind NHCarrigan.
|
- Best for: People who want more insight into the team behind NHCarrigan.
|
||||||
|
|
||||||
### 3.3 Interacting with Announcements
|
### 3.3. Interacting with Announcements
|
||||||
|
|
||||||
All of our announcements are read-only, but you can discuss them in any of our platforms mentioned in Section 2!
|
All of our announcements are read-only, but you can discuss them in any of our platforms mentioned in Section 2.
|
||||||
|
|
||||||
### 3.6 Historical Announcements
|
### 3.4. Historical Announcements
|
||||||
|
|
||||||
All announcements on our board are archived and remain accessible for future reference.
|
All announcements on our board are archived and remain accessible for future reference.
|
||||||
|
|
||||||
## 4. Professional Engagement and Portfolio
|
## 4. PROFESSIONAL ENGAGEMENT AND PORTFOLIO
|
||||||
|
|
||||||
### 4.1 LinkedIn Profile
|
### 4.1. LinkedIn Profile
|
||||||
|
|
||||||
LinkedIn serves as our primary professional networking platform.
|
LinkedIn serves as our primary professional networking platform.
|
||||||
|
|
||||||
@@ -180,11 +194,11 @@ LinkedIn serves as our primary professional networking platform.
|
|||||||
- Professional collaborators
|
- Professional collaborators
|
||||||
- Industry peers
|
- Industry peers
|
||||||
|
|
||||||
#### 4.1.1 Connecting on LinkedIn
|
#### 4.1.1. Connecting on LinkedIn
|
||||||
|
|
||||||
When sending a connection request, please include a brief message explaining your interest. We typically respond to LinkedIn messages within 2-3 business days.
|
When sending a connection request, please include a brief message explaining your interest. We typically respond to LinkedIn messages within 2-3 business days.
|
||||||
|
|
||||||
### 4.2 Professional Inquiries
|
### 4.2. Professional Inquiries
|
||||||
|
|
||||||
When reaching out for professional reasons, please consider the following:
|
When reaching out for professional reasons, please consider the following:
|
||||||
|
|
||||||
@@ -192,23 +206,23 @@ When reaching out for professional reasons, please consider the following:
|
|||||||
- Relevant Background: Provide brief context about yourself or your company.
|
- Relevant Background: Provide brief context about yourself or your company.
|
||||||
- Specific Questions: If you have particular queries, include them in your initial message.
|
- Specific Questions: If you have particular queries, include them in your initial message.
|
||||||
|
|
||||||
### 4.3 Services
|
### 4.3. Services
|
||||||
|
|
||||||
If you're interested in hiring us to perform some work for you, fill out the form at https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA.
|
If you're interested in hiring us to perform some work for you, fill out the form at https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA.
|
||||||
|
|
||||||
### 4.4 Speaking Engagements and Events
|
### 4.4. Speaking Engagements and Events
|
||||||
|
|
||||||
If you're interested in having us speak at your event or contribute to your publication, fill out the form at https://forms.nhcarrigan.com/form/Xqap3Q8hazzJd4Rrp9OOs9ip8Pa7C9zOVThlyFoPCbU.
|
If you're interested in having us speak at your event or contribute to your publication, fill out the form at https://forms.nhcarrigan.com/form/Xqap3Q8hazzJd4Rrp9OOs9ip8Pa7C9zOVThlyFoPCbU.
|
||||||
|
|
||||||
### 4.5 Keeping Professional Connections Updated
|
### 4.5. Keeping Professional Connections Updated
|
||||||
|
|
||||||
We regularly update our professional profiles with new projects, skills, and achievements. Follow us on these platforms to stay informed about our professional journey and potential opportunities for collaboration.
|
We regularly update our professional profiles with new projects, skills, and achievements. Follow us on these platforms to stay informed about our professional journey and potential opportunities for collaboration.
|
||||||
|
|
||||||
## 5. Email Communication
|
## 5. EMAIL COMMUNICATION
|
||||||
|
|
||||||
We offer several email addresses for specific types of inquiries. Please use the appropriate email address to ensure your message reaches the right team and receives the most efficient response.
|
We offer several email addresses for specific types of inquiries. Please use the appropriate email address to ensure your message reaches the right team and receives the most efficient response.
|
||||||
|
|
||||||
### 5.1 General Inquiries
|
### 5.1. General Inquiries
|
||||||
|
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -217,7 +231,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Media or press inquiries
|
- Media or press inquiries
|
||||||
- Any queries that don't fit other categories
|
- Any queries that don't fit other categories
|
||||||
|
|
||||||
### 5.2 Billing and Financial Matters
|
### 5.2. Billing and Financial Matters
|
||||||
|
|
||||||
- Email: billing@nhcarrigan.com
|
- Email: billing@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -226,7 +240,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Refund requests
|
- Refund requests
|
||||||
- Updating billing information
|
- Updating billing information
|
||||||
|
|
||||||
### 5.3 Technical Support
|
### 5.3. Technical Support
|
||||||
|
|
||||||
- Email: support@nhcarrigan.com
|
- Email: support@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -234,7 +248,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Reporting bugs or technical issues
|
- Reporting bugs or technical issues
|
||||||
- Documentation clarifications
|
- Documentation clarifications
|
||||||
|
|
||||||
### 5.4 Privacy Concerns
|
### 5.4. Privacy Concerns
|
||||||
|
|
||||||
- Email: privacy@nhcarrigan.com
|
- Email: privacy@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -243,7 +257,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Reporting potential privacy breaches
|
- Reporting potential privacy breaches
|
||||||
- Opting out of data collection (where applicable)
|
- Opting out of data collection (where applicable)
|
||||||
|
|
||||||
### 5.5 Security Matters
|
### 5.5. Security Matters
|
||||||
|
|
||||||
- Email: security@nhcarrigan.com
|
- Email: security@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -251,7 +265,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Questions about our security practices
|
- Questions about our security practices
|
||||||
- Concerns about potential security breaches
|
- Concerns about potential security breaches
|
||||||
|
|
||||||
### 5.6 Legal Inquiries
|
### 5.6. Legal Inquiries
|
||||||
|
|
||||||
- Email: legal@nhcarrigan.com
|
- Email: legal@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -260,7 +274,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Requests for legal documentation
|
- Requests for legal documentation
|
||||||
- Formal notices or communications
|
- Formal notices or communications
|
||||||
|
|
||||||
### 5.7 Feedback and Suggestions
|
### 5.7. Feedback and Suggestions
|
||||||
|
|
||||||
- Email: feedback@nhcarrigan.com
|
- Email: feedback@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -269,7 +283,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Sharing your experience with our services
|
- Sharing your experience with our services
|
||||||
- Offering ideas for future developments
|
- Offering ideas for future developments
|
||||||
|
|
||||||
### 5.8 Press/Media Inquiries
|
### 5.8. Press/Media Inquiries
|
||||||
|
|
||||||
- Email: press@nhcarrigan.com
|
- Email: press@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -277,7 +291,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Scheduling interviews for your media outlet
|
- Scheduling interviews for your media outlet
|
||||||
- Attribution requests in academic articles
|
- Attribution requests in academic articles
|
||||||
|
|
||||||
### 5.9 Event Requests
|
### 5.9. Event Requests
|
||||||
|
|
||||||
- Email: events@nhcarrigan.com
|
- Email: events@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -286,7 +300,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Workshop or training session requests
|
- Workshop or training session requests
|
||||||
- Event sponsorship inquiries
|
- Event sponsorship inquiries
|
||||||
|
|
||||||
### 5.10 Marketing Inquiries
|
### 5.10. Marketing Inquiries
|
||||||
|
|
||||||
- Email: marketing@nhcarrigan.com
|
- Email: marketing@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -295,7 +309,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Advertising inquiries
|
- Advertising inquiries
|
||||||
- Content licensing requests
|
- Content licensing requests
|
||||||
|
|
||||||
### 5.11 Career Information
|
### 5.11. Career Information
|
||||||
|
|
||||||
- Email: careers@nhcarrigan.com
|
- Email: careers@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -304,7 +318,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Inquiries
|
- Inquiries
|
||||||
- Following up on job applications
|
- Following up on job applications
|
||||||
|
|
||||||
### 5.12 Partnerships
|
### 5.12. Partnerships
|
||||||
|
|
||||||
- Email: partners@nhcarrigan.com
|
- Email: partners@nhcarrigan.com
|
||||||
- Use for:
|
- Use for:
|
||||||
@@ -313,7 +327,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Brand ambassador programmes
|
- Brand ambassador programmes
|
||||||
- Product placement or sponsored content inquiries
|
- Product placement or sponsored content inquiries
|
||||||
|
|
||||||
### 5.13 Email Communication Guidelines
|
### 5.13. Email Communication Guidelines
|
||||||
|
|
||||||
- Subject Line: Please use a clear, concise subject line that summarizes your inquiry.
|
- Subject Line: Please use a clear, concise subject line that summarizes your inquiry.
|
||||||
- Content: Provide all relevant details in your initial email to expedite the response process.
|
- Content: Provide all relevant details in your initial email to expedite the response process.
|
||||||
@@ -321,7 +335,7 @@ We offer several email addresses for specific types of inquiries. Please use the
|
|||||||
- Response Time: We aim to respond to all emails within 2 business days. Complex inquiries may require additional time.
|
- Response Time: We aim to respond to all emails within 2 business days. Complex inquiries may require additional time.
|
||||||
- Follow-ups: If you haven't received a response after 3 business days, feel free to send a polite follow-up.
|
- Follow-ups: If you haven't received a response after 3 business days, feel free to send a polite follow-up.
|
||||||
|
|
||||||
### 5.14 Email Privacy and Security
|
### 5.14. Email Privacy and Security
|
||||||
|
|
||||||
**Reference to Comprehensive Privacy Framework**: Detailed privacy protections, data handling procedures, and security measures are set forth in our Privacy Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Privacy Framework**: Detailed privacy protections, data handling procedures, and security measures are set forth in our Privacy Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
@@ -333,13 +347,13 @@ We do not share your email address or the content of your messages with third pa
|
|||||||
- As part of public safety measures related to Code of Conduct violations
|
- As part of public safety measures related to Code of Conduct violations
|
||||||
- As necessary for service provision and technical operations
|
- As necessary for service provision and technical operations
|
||||||
|
|
||||||
### 5.15 Spam and Unsolicited Emails
|
### 5.15. Spam and Unsolicited Emails
|
||||||
|
|
||||||
We have a strict no-spam policy. If you receive any unsolicited emails claiming to be from us, please report them to security@nhcarrigan.com.
|
We have a strict no-spam policy. If you receive any unsolicited emails claiming to be from us, please report them to security@nhcarrigan.com.
|
||||||
|
|
||||||
By using the appropriate email address for your inquiry, you help us provide you with the most efficient and accurate response possible. If you're unsure which email to use, feel free to send your inquiry to contact@nhcarrigan.com, and we'll direct it to the appropriate team.
|
By using the appropriate email address for your inquiry, you help us provide you with the most efficient and accurate response possible. If you're unsure which email to use, feel free to send your inquiry to contact@nhcarrigan.com, and we'll direct it to the appropriate team.
|
||||||
|
|
||||||
### 5.16 Acceptable Use and Consequences
|
### 5.16. Acceptable Use and Consequences
|
||||||
|
|
||||||
We are committed to maintaining a respectful and productive communication environment. To ensure this:
|
We are committed to maintaining a respectful and productive communication environment. To ensure this:
|
||||||
|
|
||||||
@@ -358,13 +372,13 @@ We reserve the right to report serious abuses to relevant authorities if necessa
|
|||||||
|
|
||||||
By communicating with us via email, you agree to adhere to these guidelines and understand the consequences of misuse.
|
By communicating with us via email, you agree to adhere to these guidelines and understand the consequences of misuse.
|
||||||
|
|
||||||
## 6. Direct Messages
|
## 6. DIRECT MESSAGES
|
||||||
|
|
||||||
### 6.1 Direct Message Policy
|
### 6.1. Direct Message Policy
|
||||||
|
|
||||||
We offer direct messaging as a private, personalized communication channel. However, to manage our time effectively and ensure the highest quality of service, direct messages are the lowest priority of communication. Instead, we strongly encourage you to reach out via our Discord community.
|
We offer direct messaging as a private, personalised communication channel. However, to manage our time effectively and ensure the highest quality of service, direct messages are the lowest priority of communication. Instead, we strongly encourage you to reach out via our Discord community.
|
||||||
|
|
||||||
### 6.2 Purpose and Use
|
### 6.2. Purpose and Use
|
||||||
|
|
||||||
Direct messages should be used for:
|
Direct messages should be used for:
|
||||||
|
|
||||||
@@ -372,26 +386,64 @@ Direct messages should be used for:
|
|||||||
- Sensitive information that shouldn't be shared publicly
|
- Sensitive information that shouldn't be shared publicly
|
||||||
- Personalized support or consultation requests
|
- Personalized support or consultation requests
|
||||||
|
|
||||||
### 6.3 Response Time
|
### 6.3. Response Time
|
||||||
|
|
||||||
- We aim to respond to direct messages within 5-7 business days.
|
- We aim to respond to direct messages within 5-7 business days.
|
||||||
- Complex inquiries may require additional time, which will be communicated to you.
|
- Complex inquiries may require additional time, which will be communicated to you.
|
||||||
|
|
||||||
### 6.4 Appropriate Use
|
### 6.4. Appropriate Use
|
||||||
|
|
||||||
- Direct messages should be used responsibly and for legitimate purposes only.
|
- Direct messages should be used responsibly and for legitimate purposes only.
|
||||||
- Abusive, harassing, or spam messages will not be tolerated and may result in blocking or reporting to the platform.
|
- Abusive, harassing, or spam messages will not be tolerated and may result in blocking or reporting to the platform.
|
||||||
|
|
||||||
### 6.5 Alternatives
|
### 6.5. Alternatives
|
||||||
|
|
||||||
We encourage users to consider the following alternatives before sending a direct message:
|
We encourage users to consider the following alternatives before sending a direct message:
|
||||||
|
|
||||||
- Use our public support channels for general inquiries (see Section 1.1)
|
- Use our public support channels for general inquiries (see Section 1.1)
|
||||||
- Check our FAQ or documentation for commonly asked questions
|
- Check our FAQ or documentation for commonly asked questions
|
||||||
- Post in our community forums for non-urgent matters
|
- Post in our Discord community forum channels for non-urgent matters
|
||||||
|
|
||||||
### 6.7 Consent and Acknowledgment
|
### 6.6. Consent and Acknowledgment
|
||||||
|
|
||||||
By sending a direct message, you acknowledge that you have read and agreed to this policy.
|
By sending a direct message, you acknowledge that you have read and agreed to this Policy.
|
||||||
|
|
||||||
Remember, while we value direct communication, we encourage the use of our public channels whenever possible to foster community engagement and shared learning.
|
**IMPORTANT: While we value direct communication, we strongly encourage the use of our public channels whenever possible to foster community engagement and shared learning. Direct messages are the lowest priority communication channel and may experience significant response delays.**
|
||||||
|
|
||||||
|
## 7. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 7.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all matters related to communications and contact with our organisation.**
|
||||||
|
|
||||||
|
### 7.2. Communication-Specific Disclaimers
|
||||||
|
|
||||||
|
**Additional Limitations:**
|
||||||
|
**(a)** We are not liable for delays, failures, or errors in communication delivery or processing;
|
||||||
|
**(b)** We do not guarantee response times or availability of any communication channel;
|
||||||
|
**(c)** We are not responsible for third-party platform failures or communication service interruptions;
|
||||||
|
**(d)** Our liability is limited to the maximum extent permitted by applicable law.
|
||||||
|
|
||||||
|
## 8. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
|
### 8.1. General Contact
|
||||||
|
|
||||||
|
For general inquiries about this Policy or our communication channels:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
|
**Response Time:** Within 48 hours for general inquiries
|
||||||
|
|
||||||
|
### 8.2. Policy Questions
|
||||||
|
|
||||||
|
For questions about this Contact Policy:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Subject Line:** Contact Policy Inquiry - [Brief Description]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This Contact Policy establishes the terms and standards governing all communications with our organisation. By engaging in communication with us, you acknowledge that you have read, understood, and agree to comply with this Policy and all incorporated legal frameworks. For questions about this Policy, please contact us at contact@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -1,55 +1,237 @@
|
|||||||
---
|
---
|
||||||
title: Support Our Work 💜
|
title: Donation and Support Policy
|
||||||
---
|
---
|
||||||
|
|
||||||
:::tip
|
**SUPPORTING OUR MISSION THROUGH VOLUNTARY CONTRIBUTIONS**
|
||||||
We have started tracking our organisation's income and expenses publicly, through our [OpenCollective](https://opencollective.com/nhcarrigan) account!
|
|
||||||
|
|
||||||
You can also donate there directly.
|
## 1. INTRODUCTION AND PURPOSE
|
||||||
:::
|
|
||||||
|
|
||||||
We are passionate about creating and maintaining free-to-use projects and providing guidance in various programming communities. Your support helps us continue this mission and expand our efforts.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
## 1. Why Support Us?
|
This Donation and Support Policy ("Policy") establishes the terms, conditions, and procedures governing voluntary financial contributions and other forms of support to NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
|
||||||
|
|
||||||
- **Free Resources**: We offer numerous projects that are free for everyone to use and learn from.
|
### 1.2. Legal Framework Integration
|
||||||
- **Community Guidance**: We actively participate in programming communities, offering help and mentorship.
|
|
||||||
- **Open Source Contributions**: Your support enables us to dedicate more time to open source development.
|
|
||||||
- **Continuous Improvement**: Donations help us improve existing projects and create new ones.
|
|
||||||
|
|
||||||
## 2. How Your Support Helps
|
**IMPORTANT: All donations and support are voluntary contributions. This Policy does not create any contractual obligations, warranties, or guarantees regarding the use of donated funds or the provision of any services or benefits. Comprehensive disclaimers and liability limitations are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
- Covers hosting and infrastructure costs
|
### 1.3. Scope of Application
|
||||||
- Allows us to dedicate more time to project development and community support
|
|
||||||
- Enables us to invest in better tools and resources
|
|
||||||
- Supports our ongoing education and skill development
|
|
||||||
|
|
||||||
## 3. Ways to Support
|
This Policy applies to:
|
||||||
|
**(a)** All voluntary financial contributions made to NHCarrigan;
|
||||||
|
**(b)** All forms of non-financial support and contributions;
|
||||||
|
**(c)** All donation platforms and payment processors used for contributions;
|
||||||
|
**(d)** All benefits, recognition, or acknowledgements associated with contributions.
|
||||||
|
|
||||||
We offer a few options for donations!
|
## 2. DONATION PURPOSE AND USE
|
||||||
|
|
||||||
- You can donate on our [OpenCollective](https://opencollective.com/nhcarrigan) page
|
### 2.1. Mission and Objectives
|
||||||
- You can donate via a monthly subscription in our [Discord community](https://chat.nhcarrigan.com)
|
|
||||||
- You can donate via a monthly membership on our [Patreon](https://patreon.com/nhcarrigan)
|
|
||||||
- You can make monthly or one-time donations on [Ko-Fi](https://ko-fi.com/nhcarrigan)
|
|
||||||
- You can suggest and purchase gifts for us on [Throne](https://throne.com/naomilgbt)
|
|
||||||
- You can subscribe to our [Twitch streams](https://twitch.tv/naomilgbt)
|
|
||||||
- You can send direct donations via [PayPal](https://paypal.me/nhcarrigan) or [CashApp](https://cash.app/$nhcarrigan)
|
|
||||||
- You can sponsor us directly through our [GitHub organisation](https://github.com/sponsors/nhcarrigan) or [Naomi's account](https://github.com/sponsors/naomi-lgbt)
|
|
||||||
- Want to keep it simple? Make [monthly](https://buy.stripe.com/cN24iTfqu1j6b3afZ2) or [one-time](https://donate.stripe.com/8wMcPp1zE8Ly2wEcMR) donations directly through Stripe!
|
|
||||||
|
|
||||||
## 4. Other Ways to Help
|
We are committed to creating and maintaining free-to-use projects and providing guidance in various programming communities. Voluntary contributions support our mission to:
|
||||||
|
|
||||||
- **Spread the Word**: Share our projects and resources with others who might benefit.
|
**(a)** **Free Resource Development**: Create and maintain projects that are free for everyone to use and learn from;
|
||||||
- **Contribute**: If you have skills to offer, consider contributing to our open source projects.
|
**(b)** **Community Guidance**: Provide active participation in programming communities, offering help and mentorship;
|
||||||
- **Provide Feedback**: Your input helps us improve and refine our work.
|
**(c)** **Open Source Contributions**: Enable dedicated time to open source development and community support;
|
||||||
|
**(d)** **Continuous Improvement**: Improve existing projects and create new resources for the community.
|
||||||
|
|
||||||
## 5. Thank You!
|
### 2.2. Use of Donated Funds
|
||||||
|
|
||||||
Every contribution, no matter the size, makes a significant impact. We deeply appreciate your support and are committed to using it to benefit the wider programming community.
|
Donated funds may be used for:
|
||||||
|
|
||||||
For any questions about donations or to discuss other support options, please contact us at donors@nhcarrigan.com.
|
**(a)** **Infrastructure Costs**: Hosting, servers, and technical infrastructure necessary for service provision;
|
||||||
|
**(b)** **Development Resources**: Tools, software licences, and resources necessary for project development;
|
||||||
|
**(c)** **Community Support**: Time and resources dedicated to community support and mentorship activities;
|
||||||
|
**(d)** **Educational Development**: Ongoing education and skill development to enhance service quality;
|
||||||
|
**(e)** **Organisational Operations**: Reasonable operational expenses necessary for organisational functioning.
|
||||||
|
|
||||||
## 6. Perks
|
### 2.3. Financial Transparency
|
||||||
|
|
||||||
Once you have donated, make sure to join our [Discord](https://chat.nhcarrigan.com)! Once there, ping Naomi to request access to our special supporters channel and role!
|
We maintain transparency regarding our organisation's income and expenses through our publicly accessible [OpenCollective](https://opencollective.com/NHCarrigan) account, where donors may review financial information and contribute directly.
|
||||||
|
|
||||||
|
**IMPORTANT DISCLAIMER:**
|
||||||
|
The ledger is updated as our workload allows. We make no guarantee of timely accuracy.
|
||||||
|
|
||||||
|
### 2.4. No Guarantees or Obligations
|
||||||
|
|
||||||
|
**IMPORTANT DISCLAIMER:**
|
||||||
|
**(a)** Donations do not create any contractual obligations or guarantees regarding specific project outcomes or service levels;
|
||||||
|
**(b)** We reserve the right to allocate donated funds at our sole discretion in furtherance of our mission;
|
||||||
|
**(c)** Donations do not entitle donors to any ownership interest, voting rights, or control over organisational decisions;
|
||||||
|
**(d)** We are not obligated to provide any specific services, features, or benefits in exchange for donations.
|
||||||
|
|
||||||
|
## 3. DONATION METHODS AND PLATFORMS
|
||||||
|
|
||||||
|
### 3.1. Available Donation Platforms
|
||||||
|
|
||||||
|
We accept voluntary contributions through the following platforms:
|
||||||
|
|
||||||
|
**(a)** **OpenCollective**: [https://opencollective.com/NHCarrigan](https://opencollective.com/NHCarrigan) - Primary platform for organisational donations and financial transparency;
|
||||||
|
**(b)** **Discord Community**: Monthly subscription options available within our [Discord community](https://chat.nhcarrigan.com);
|
||||||
|
**(c)** **Patreon**: Monthly membership options available at [https://patreon.com/NHCarrigan](https://patreon.com/NHCarrigan);
|
||||||
|
**(d)** **Ko-Fi**: Monthly or one-time donations available at [https://ko-fi.com/NHCarrigan](https://ko-fi.com/NHCarrigan);
|
||||||
|
**(e)** **Throne**: Gift suggestions and purchases available at [https://throne.com/naomilgbt](https://throne.com/naomilgbt);
|
||||||
|
**(f)** **Twitch**: Subscription options available through our [Twitch streams](https://twitch.tv/naomilgbt);
|
||||||
|
**(g)** **PayPal**: Direct donations via [https://paypal.me/NHCarrigan](https://paypal.me/NHCarrigan);
|
||||||
|
**(h)** **CashApp**: Direct donations via [https://cash.app/$NHCarrigan](https://cash.app/$NHCarrigan);
|
||||||
|
**(i)** **GitHub Sponsors**: Sponsorship options through our [GitHub organisation](https://github.com/sponsors/NHCarrigan) or [Naomi's account](https://github.com/sponsors/naomi-lgbt);
|
||||||
|
**(j)** **Stripe**: Direct [monthly](https://buy.stripe.com/cN24iTfqu1j6b3afZ2) or [one-time](https://donate.stripe.com/8wMcPp1zE8Ly2wEcMR) donations.
|
||||||
|
|
||||||
|
### 3.2. Third-Party Platform Terms
|
||||||
|
|
||||||
|
All donations processed through third-party platforms are subject to:
|
||||||
|
**(a)** The terms of service and privacy policies of the respective platform;
|
||||||
|
**(b)** Platform-specific fees, processing charges, and payment terms;
|
||||||
|
**(c)** Platform security measures and data handling practices;
|
||||||
|
**(d)** Our Privacy Policy regarding collection and processing of donor information.
|
||||||
|
|
||||||
|
### 3.3. Payment Processing
|
||||||
|
|
||||||
|
**(a)** All payment processing is handled by third-party payment processors;
|
||||||
|
**(b)** We do not directly process or store payment card information;
|
||||||
|
**(c)** Payment security is the responsibility of the respective payment platform;
|
||||||
|
**(d)** We are not liable for any issues arising from third-party payment processing.
|
||||||
|
|
||||||
|
## 4. DONOR RECOGNITION AND BENEFITS
|
||||||
|
|
||||||
|
### 4.1. Recognition Programmes
|
||||||
|
|
||||||
|
We may provide recognition to donors through:
|
||||||
|
**(a)** Public acknowledgement in donor recognition lists (with explicit consent);
|
||||||
|
**(b)** Special roles or channels in our community platforms;
|
||||||
|
**(c)** Access to supporter-exclusive content or features;
|
||||||
|
**(d)** Other forms of recognition as determined at our sole discretion.
|
||||||
|
|
||||||
|
### 4.2. Supporter Benefits
|
||||||
|
|
||||||
|
Donors may be eligible for certain benefits, including:
|
||||||
|
**(a)** **Discord Community Access**: Access to special supporters channels and roles within our [Discord community](https://chat.nhcarrigan.com);
|
||||||
|
**(b)** **Early Access**: Early access to new features or content where applicable;
|
||||||
|
**(c)** **Recognition**: Public recognition in donor lists or supporter acknowledgements (with consent);
|
||||||
|
**(d)** **Community Engagement**: Enhanced engagement opportunities within our community platforms.
|
||||||
|
|
||||||
|
### 4.3. Benefit Limitations
|
||||||
|
|
||||||
|
**IMPORTANT:**
|
||||||
|
**(a)** Benefits are provided at our sole discretion and may be modified or discontinued at any time;
|
||||||
|
**(b)** Benefits do not create any contractual rights or obligations;
|
||||||
|
**(c)** We reserve the right to revoke benefits for violations of our Terms of Service or Community Code of Conduct;
|
||||||
|
**(d)** Benefits may vary based on donation amount, platform, or other factors determined by us.
|
||||||
|
|
||||||
|
### 4.4. Benefit Activation
|
||||||
|
|
||||||
|
To activate supporter benefits:
|
||||||
|
**(a)** Join our [Discord community](https://chat.nhcarrigan.com);
|
||||||
|
**(b)** Contact community leadership to request access to supporter channels and roles;
|
||||||
|
**(c)** Provide verification of donation if requested;
|
||||||
|
**(d)** Comply with all community standards and policies.
|
||||||
|
|
||||||
|
## 5. ALTERNATIVE FORMS OF SUPPORT
|
||||||
|
|
||||||
|
### 5.1. Non-Financial Contributions
|
||||||
|
|
||||||
|
We value and appreciate various forms of non-financial support:
|
||||||
|
|
||||||
|
**(a)** **Community Engagement**: Active participation in our community platforms and discussions;
|
||||||
|
**(b)** **Project Contributions**: Contributing code, documentation, or other resources to our open source projects;
|
||||||
|
**(c)** **Promotion and Advocacy**: Sharing our projects and resources with others who might benefit;
|
||||||
|
**(d)** **Feedback and Input**: Providing constructive feedback to help us improve and refine our work.
|
||||||
|
|
||||||
|
### 5.2. Contribution Guidelines
|
||||||
|
|
||||||
|
All non-financial contributions are subject to:
|
||||||
|
**(a)** Our Terms of Service and Acceptable Use Policy;
|
||||||
|
**(b)** Our Community Code of Conduct;
|
||||||
|
**(c)** Our Contributing Documentation for code and technical contributions;
|
||||||
|
**(d)** All applicable legal and policy frameworks.
|
||||||
|
|
||||||
|
## 6. DONATION TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### 6.1. Voluntary Nature
|
||||||
|
|
||||||
|
**(a)** All donations are strictly voluntary and non-refundable;
|
||||||
|
**(b)** Donations do not create any employment, partnership, or business relationship;
|
||||||
|
**(c)** Donations are not investments and do not provide any financial return or equity interest;
|
||||||
|
**(d)** We are not obligated to accept any donation and may refuse donations at our sole discretion.
|
||||||
|
|
||||||
|
### 6.2. Refund Policy
|
||||||
|
|
||||||
|
**(a)** Donations are generally non-refundable;
|
||||||
|
**(b)** Refund requests will be considered on a case-by-case basis for exceptional circumstances;
|
||||||
|
**(c)** Refund requests must be submitted within thirty (30) days of the donation date;
|
||||||
|
**(d)** Processing fees charged by payment platforms are non-refundable.
|
||||||
|
|
||||||
|
### 6.3. Tax Considerations
|
||||||
|
|
||||||
|
**(a)** We are not a tax-exempt organisation and cannot provide tax deduction documentation;
|
||||||
|
**(b)** Donors are responsible for determining the tax implications of their contributions;
|
||||||
|
**(c)** We recommend consulting with a tax professional regarding donation tax treatment;
|
||||||
|
**(d)** We do not provide tax advice or tax-related documentation.
|
||||||
|
|
||||||
|
### 6.4. Donation Modifications and Cancellations
|
||||||
|
|
||||||
|
**(a)** Recurring donations may be cancelled through the respective payment platform;
|
||||||
|
**(b)** We are not responsible for cancellation processes managed by third-party platforms;
|
||||||
|
**(c)** Cancellation of recurring donations does not affect benefits already provided;
|
||||||
|
**(d)** We reserve the right to modify or discontinue donation programmes at any time.
|
||||||
|
|
||||||
|
## 7. PRIVACY AND DATA PROTECTION
|
||||||
|
|
||||||
|
### 7.1. Donor Information
|
||||||
|
|
||||||
|
Donor information is handled in accordance with our Privacy Policy:
|
||||||
|
**(a)** We collect only information necessary for processing donations and providing benefits;
|
||||||
|
**(b)** Donor information is not sold or shared with third parties except as necessary for payment processing;
|
||||||
|
**(c)** Donors may request access to or deletion of their personal information;
|
||||||
|
**(d)** Public recognition requires explicit consent from donors.
|
||||||
|
|
||||||
|
### 7.2. Payment Information
|
||||||
|
|
||||||
|
**(a)** We do not directly process or store payment card information;
|
||||||
|
**(b)** Payment information is handled by third-party payment processors in accordance with their privacy policies;
|
||||||
|
**(c)** We are not responsible for data breaches or security incidents affecting third-party payment platforms;
|
||||||
|
**(d)** Donors should review payment platform privacy policies before making contributions.
|
||||||
|
|
||||||
|
## 8. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 8.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all matters related to donations and support.**
|
||||||
|
|
||||||
|
### 8.2. Donation-Specific Disclaimers
|
||||||
|
|
||||||
|
In addition to comprehensive liability limitations:
|
||||||
|
**(a)** We are not liable for any issues arising from third-party payment platform failures or errors;
|
||||||
|
**(b)** We are not responsible for benefits or recognition that cannot be provided due to technical or operational limitations;
|
||||||
|
**(c)** We do not guarantee that donations will result in specific project outcomes or service improvements;
|
||||||
|
**(d)** We are not liable for any tax consequences or legal implications of donations.
|
||||||
|
|
||||||
|
## 9. CONTACT INFORMATION
|
||||||
|
|
||||||
|
### 9.1. Donation Inquiries
|
||||||
|
|
||||||
|
For questions about donations or support options:
|
||||||
|
|
||||||
|
**Email:** donors@nhcarrigan.com
|
||||||
|
|
||||||
|
**Response Time:** Within 48 hours for donation-related inquiries
|
||||||
|
|
||||||
|
### 9.2. General Contact
|
||||||
|
|
||||||
|
For general inquiries about our organisation or services:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
|
## 10. ACKNOWLEDGEMENT AND GRATITUDE
|
||||||
|
|
||||||
|
### 10.1. Appreciation Statement
|
||||||
|
|
||||||
|
We extend our sincere gratitude to all individuals and organisations who support our mission through voluntary contributions. Every contribution, regardless of size, makes a significant impact on our ability to serve the programming community and maintain free, accessible resources.
|
||||||
|
|
||||||
|
### 10.2. Commitment to Mission
|
||||||
|
|
||||||
|
We are committed to using all contributions responsibly and effectively to further our mission of creating inclusive, accessible technology resources and supporting programming communities worldwide.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This Donation and Support Policy establishes the terms governing voluntary contributions to our organisation. By making a donation, you acknowledge that you have read, understood, and agree to the terms set forth in this Policy. For questions about donations, please contact us at donors@nhcarrigan.com.*
|
||||||
|
|||||||
+243
-33
@@ -1,55 +1,265 @@
|
|||||||
---
|
---
|
||||||
title: Hire us!
|
title: Professional Services and Commission Policy
|
||||||
---
|
---
|
||||||
|
|
||||||
We're excited about the opportunity to collaborate with you and contribute to the success of your goals. Our team brings a wealth of experience and a passion for delivering high-quality solutions tailored to your specific needs.
|
**PROFESSIONAL SERVICES, CONSULTING, AND COMMISSION ENGAGEMENTS**
|
||||||
|
|
||||||

|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
## 1. Our Services
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
- **Discord Bot Development**: Custom bots to enhance your server's functionality
|
This Professional Services and Commission Policy ("Policy") establishes the terms, conditions, and procedures governing professional services, consulting engagements, and commission-based work provided by NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
|
||||||
- **Web Development**: From simple websites to complex web applications
|
|
||||||
- **Community Management**: Strategies to grow and maintain thriving online communities
|
|
||||||
- **Technical Consulting**: Expert advice on your tech-related projects and decisions
|
|
||||||
|
|
||||||
## 2. Engagement Options
|
### 1.2. Legal Framework Integration
|
||||||
|
|
||||||
We offer flexible ways to work together, catering to projects of all sizes and complexities:
|
**IMPORTANT: This Policy does not create any binding service agreements. All professional services engagements require separate written agreements that supersede this Policy. Comprehensive disclaimers, warranty limitations, and liability protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
### 2.1. Quick Sync (15 minutes)
|
### 1.3. Scope of Application
|
||||||
|
|
||||||
For those with a well-defined product idea or seeking a quick review of their community plan, book a quick sync.
|
This Policy applies to:
|
||||||
|
**(a)** All professional services and consulting engagements;
|
||||||
|
**(b)** All commission-based development and technical work;
|
||||||
|
**(c)** All mentorship and training services;
|
||||||
|
**(d)** All initial consultations and project discussions.
|
||||||
|
|
||||||
- Ideal for: Initial project discussions, quick advice, or community plan reviews
|
## 2. AVAILABLE SERVICES
|
||||||
- Duration: 15 minutes
|
|
||||||
- Outcome: Rapid insights and direction for your project
|
|
||||||
|
|
||||||
### 2.2. In-Depth Consultation (30 minutes)
|
### 2.1. Service Categories
|
||||||
|
|
||||||
For more complex, long-term, or in-depth projects, we recommend booking an in-depth consultation.
|
We offer professional services in the following categories:
|
||||||
|
|
||||||
- Ideal for: Detailed project planning, technical strategy discussions, or exploring long-term collaborations
|
**(a)** **Discord Bot Development**: Custom bot development to enhance server functionality, including feature implementation, integration services, and ongoing maintenance;
|
||||||
- Duration: 30 minutes
|
**(b)** **Web Development**: Website and web application development services, ranging from simple websites to complex web applications, including front-end and back-end development;
|
||||||
- Outcome: Comprehensive project assessment and tailored recommendations
|
**(c)** **Community Management**: Strategic consulting and services for growing and maintaining thriving online communities, including moderation strategies, engagement programmes, and community growth planning;
|
||||||
|
**(d)** **Technical Consulting**: Expert technical advice and consultation on technology-related projects, decisions, and strategic planning.
|
||||||
|
|
||||||
### 2.3. Mentorship Session (60 minutes)
|
### 2.2. Service Limitations
|
||||||
|
|
||||||
For those seeking personalized guidance and skill development, we offer a full mentorship session.
|
**IMPORTANT DISCLAIMERS:**
|
||||||
|
**(a)** Services are provided subject to availability and our sole discretion to accept or decline engagements;
|
||||||
|
**(b)** Service scope, deliverables, and timelines are determined through separate written agreements;
|
||||||
|
**(c)** We reserve the right to refuse service for any reason, including conflicts of interest, resource constraints, or project incompatibility;
|
||||||
|
**(d)** All services are subject to our Terms of Service, Acceptable Use Policy, and applicable legal frameworks.
|
||||||
|
|
||||||
- Ideal for: Individuals looking to enhance their skills in development, community management, or related areas
|
## 3. ENGAGEMENT OPTIONS AND CONSULTATION SERVICES
|
||||||
- Duration: 60 minutes
|
|
||||||
- Outcome: Personalized learning path, hands-on projects, and ongoing support
|
|
||||||
|
|
||||||
## 3. Why Choose Us?
|
### 3.1. Initial Consultation Services
|
||||||
|
|
||||||
- **Expertise**: Years of experience in development and community management
|
We offer structured consultation services to assess project needs and determine appropriate engagement approaches:
|
||||||
- **Flexibility**: Multiple engagement options to suit your needs and preferences
|
|
||||||
- **Personalized Approach**: Tailored solutions for your unique challenges
|
|
||||||
- **Commitment to Quality**: Delivering high-value insights and solutions in every interaction
|
|
||||||
|
|
||||||
## 4. Ready to Get Started?
|
### 3.2. Quick Sync Consultation (15 Minutes)
|
||||||
|
|
||||||
Submit a [commission request](https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA)!
|
**Purpose and Scope:**
|
||||||
|
**(a)** **Intended Use**: Initial project discussions, quick advice, or community plan reviews for well-defined product ideas;
|
||||||
|
**(b)** **Duration**: Fifteen (15) minutes;
|
||||||
|
**(c)** **Outcome**: Rapid insights and directional guidance for project planning;
|
||||||
|
**(d)** **Limitations**: Quick sync consultations provide preliminary guidance only and do not constitute comprehensive project planning or binding service commitments.
|
||||||
|
|
||||||
Not sure which option is right for you? Feel free to contact us with any questions. We're excited to explore how we can help bring your ideas to life and contribute to your success!
|
### 3.3. In-Depth Consultation (30 Minutes)
|
||||||
|
|
||||||
|
**Purpose and Scope:**
|
||||||
|
**(a)** **Intended Use**: Detailed project planning, technical strategy discussions, or exploration of long-term collaboration opportunities for complex, long-term, or in-depth projects;
|
||||||
|
**(b)** **Duration**: Thirty (30) minutes;
|
||||||
|
**(c)** **Outcome**: Comprehensive project assessment and tailored recommendations;
|
||||||
|
**(d)** **Limitations**: In-depth consultations provide strategic guidance but do not constitute binding service agreements or guarantee project acceptance.
|
||||||
|
|
||||||
|
### 3.4. Mentorship Session (60 Minutes)
|
||||||
|
|
||||||
|
**Purpose and Scope:**
|
||||||
|
**(a)** **Intended Use**: Personalized guidance and skill development for individuals seeking to enhance skills in development, community management, or related technical areas;
|
||||||
|
**(b)** **Duration**: Sixty (60) minutes;
|
||||||
|
**(c)** **Outcome**: Personalized learning path recommendations, hands-on project guidance, and ongoing support planning;
|
||||||
|
**(d)** **Limitations**: Mentorship sessions provide educational guidance and do not create ongoing mentorship relationships unless separately agreed.
|
||||||
|
|
||||||
|
### 3.5. Consultation Terms and Conditions
|
||||||
|
|
||||||
|
**IMPORTANT:**
|
||||||
|
**(a)** Consultation services are provided for informational and planning purposes only;
|
||||||
|
**(b)** Consultations do not create any binding service agreements or commitments;
|
||||||
|
**(c)** All consultation outcomes, recommendations, and advice are provided "as is" without warranties;
|
||||||
|
**(d)** Consultation fees, if applicable, are non-refundable and do not guarantee project acceptance or service provision.
|
||||||
|
|
||||||
|
## 4. SERVICE ENGAGEMENT PROCESS
|
||||||
|
|
||||||
|
### 4.1. Initial Inquiry and Assessment
|
||||||
|
|
||||||
|
**Engagement Process:**
|
||||||
|
**(a)** **Commission Request Submission**: Submit initial inquiries through our [commission request form](https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA);
|
||||||
|
**(b)** **Initial Review**: We review all commission requests to assess project scope, compatibility, and resource availability;
|
||||||
|
**(c)** **Consultation Scheduling**: Appropriate consultation services may be scheduled to discuss project requirements and engagement options;
|
||||||
|
**(d)** **Project Assessment**: Comprehensive assessment of project feasibility, timeline, and resource requirements.
|
||||||
|
|
||||||
|
### 4.2. Service Agreement Requirements
|
||||||
|
|
||||||
|
**Formal Engagement:**
|
||||||
|
**(a)** All professional service engagements require separate written service agreements;
|
||||||
|
**(b)** Service agreements specify project scope, deliverables, timelines, compensation, and terms;
|
||||||
|
**(c)** No services are provided until a written service agreement is executed by both parties;
|
||||||
|
**(d)** Service agreements supersede this Policy and establish binding terms for specific engagements.
|
||||||
|
|
||||||
|
### 4.3. Project Acceptance and Rejection
|
||||||
|
|
||||||
|
**Engagement Decisions:**
|
||||||
|
**(a)** We reserve the right to accept or decline any project at our sole discretion;
|
||||||
|
**(b)** Project acceptance is subject to resource availability, project compatibility, and our assessment of project feasibility;
|
||||||
|
**(c)** We are not obligated to provide reasons for project rejection;
|
||||||
|
**(d)** Consultation fees, if paid, are non-refundable regardless of project acceptance or rejection.
|
||||||
|
|
||||||
|
## 5. SERVICE QUALITY AND DELIVERABLES
|
||||||
|
|
||||||
|
### 5.1. Service Standards
|
||||||
|
|
||||||
|
We are committed to delivering high-quality professional services:
|
||||||
|
**(a)** **Expertise**: Years of experience in development, community management, and technical consulting;
|
||||||
|
**(b)** **Flexibility**: Multiple engagement options to accommodate diverse project needs and preferences;
|
||||||
|
**(c)** **Personalized Approach**: Tailored solutions addressing unique project challenges and requirements;
|
||||||
|
**(d)** **Quality Commitment**: Focus on delivering high-value insights and solutions in every engagement.
|
||||||
|
|
||||||
|
### 5.2. Deliverable Specifications
|
||||||
|
|
||||||
|
**Service Deliverables:**
|
||||||
|
**(a)** All deliverables are specified in individual service agreements;
|
||||||
|
**(b)** Deliverables are provided in accordance with agreed specifications and timelines;
|
||||||
|
**(c)** We reserve the right to modify deliverables with client consent and appropriate agreement amendments;
|
||||||
|
**(d)** Deliverable acceptance and approval processes are established in service agreements.
|
||||||
|
|
||||||
|
### 5.3. Service Limitations and Disclaimers
|
||||||
|
|
||||||
|
**IMPORTANT DISCLAIMERS:**
|
||||||
|
**(a)** Services are provided "as is" subject to the limitations and disclaimers in our Limitation of Liability and Indemnification Policy;
|
||||||
|
**(b)** We do not guarantee specific project outcomes, business results, or performance metrics;
|
||||||
|
**(c)** Service quality and outcomes may vary based on project complexity, client cooperation, and external factors;
|
||||||
|
**(d)** We are not responsible for client decisions made based on our services or recommendations.
|
||||||
|
|
||||||
|
## 6. COMPENSATION AND PAYMENT TERMS
|
||||||
|
|
||||||
|
### 6.1. Fee Structure
|
||||||
|
|
||||||
|
**Compensation Arrangements:**
|
||||||
|
**(a)** Consultation fees, if applicable, are specified at the time of consultation scheduling;
|
||||||
|
**(b)** Professional service fees are established in individual service agreements;
|
||||||
|
**(c)** Payment terms, schedules, and methods are specified in service agreements;
|
||||||
|
**(d)** All fees are non-refundable except as specifically provided in service agreements.
|
||||||
|
|
||||||
|
### 6.2. Payment Processing
|
||||||
|
|
||||||
|
**Payment Methods:**
|
||||||
|
**(a)** Payments are processed through secure third-party payment processors;
|
||||||
|
**(b)** Payment processing is subject to third-party platform terms and conditions;
|
||||||
|
**(c)** We are not responsible for payment processing delays or issues caused by third-party platforms;
|
||||||
|
**(d)** Payment information is handled in accordance with our Privacy Policy and applicable data protection laws.
|
||||||
|
|
||||||
|
### 6.3. Refund Policy
|
||||||
|
|
||||||
|
**Refund Terms:**
|
||||||
|
**(a)** Consultation fees are non-refundable;
|
||||||
|
**(b)** Professional service refunds are governed by individual service agreements;
|
||||||
|
**(c)** Refund requests must be submitted in writing and are subject to our review and approval;
|
||||||
|
**(d)** We reserve the right to refuse refunds for services already provided or work already completed.
|
||||||
|
|
||||||
|
## 7. INTELLECTUAL PROPERTY AND OWNERSHIP
|
||||||
|
|
||||||
|
### 7.1. Work Product Ownership
|
||||||
|
|
||||||
|
**Intellectual Property Rights:**
|
||||||
|
**(a)** Work product ownership is specified in individual service agreements;
|
||||||
|
**(b)** Unless otherwise agreed, we retain ownership of pre-existing intellectual property, tools, and methodologies;
|
||||||
|
**(c)** Client-specific work product ownership is determined by service agreement terms;
|
||||||
|
**(d)** All intellectual property terms are subject to applicable laws and our Terms of Service.
|
||||||
|
|
||||||
|
### 7.2. License and Usage Rights
|
||||||
|
|
||||||
|
**Usage Rights:**
|
||||||
|
**(a)** Usage rights for work product are established in service agreements;
|
||||||
|
**(b)** We may retain rights to use anonymised work product for portfolio and marketing purposes;
|
||||||
|
**(c)** Client usage rights are limited to the scope specified in service agreements;
|
||||||
|
**(d)** Unauthorised use of work product may constitute intellectual property infringement.
|
||||||
|
|
||||||
|
## 8. CONFIDENTIALITY AND PRIVACY
|
||||||
|
|
||||||
|
### 8.1. Confidential Information
|
||||||
|
|
||||||
|
**Confidentiality Obligations:**
|
||||||
|
**(a)** Confidentiality terms are established in individual service agreements;
|
||||||
|
**(b)** We maintain confidentiality of client information in accordance with our Privacy Policy and service agreements;
|
||||||
|
**(c)** Client information is not shared with third parties except as necessary for service provision or as required by law;
|
||||||
|
**(d)** Confidentiality obligations survive termination of service agreements.
|
||||||
|
|
||||||
|
### 8.2. Data Protection
|
||||||
|
|
||||||
|
**Privacy and Data Security:**
|
||||||
|
**(a)** Client data is handled in accordance with our Privacy Policy and applicable data protection laws;
|
||||||
|
**(b)** We implement reasonable security measures to protect client information;
|
||||||
|
**(c)** We are not liable for data breaches caused by third-party systems or client security failures;
|
||||||
|
**(d)** Data retention and deletion policies are specified in service agreements.
|
||||||
|
|
||||||
|
## 9. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 9.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, maximum liability caps, and all related legal protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all matters related to professional services and consulting engagements.**
|
||||||
|
|
||||||
|
### 9.2. Service-Specific Disclaimers
|
||||||
|
|
||||||
|
**Additional Limitations:**
|
||||||
|
**(a)** We are not liable for business decisions, outcomes, or results based on our services or recommendations;
|
||||||
|
**(b)** We do not guarantee specific project outcomes, performance metrics, or business results;
|
||||||
|
**(c)** We are not responsible for third-party services, platforms, or tools used in connection with our services;
|
||||||
|
**(d)** Our liability is limited to the maximum extent permitted by applicable law and service agreements.
|
||||||
|
|
||||||
|
## 10. TERMINATION AND CANCELLATION
|
||||||
|
|
||||||
|
### 10.1. Service Termination
|
||||||
|
|
||||||
|
**Termination Rights:**
|
||||||
|
**(a)** Termination rights and procedures are specified in individual service agreements;
|
||||||
|
**(b)** We reserve the right to terminate services for violations of our Terms of Service or service agreements;
|
||||||
|
**(c)** Clients may terminate services in accordance with service agreement terms;
|
||||||
|
**(d)** Termination does not affect accrued obligations or rights established prior to termination.
|
||||||
|
|
||||||
|
### 10.2. Cancellation Policy
|
||||||
|
|
||||||
|
**Cancellation Terms:**
|
||||||
|
**(a)** Consultation cancellations are subject to our cancellation policy specified at the time of scheduling;
|
||||||
|
**(b)** Service engagement cancellations are governed by individual service agreements;
|
||||||
|
**(c)** Cancellation fees may apply as specified in service agreements;
|
||||||
|
**(d)** We reserve the right to refuse future services following cancellation or termination.
|
||||||
|
|
||||||
|
## 11. CONTACT INFORMATION AND INQUIRIES
|
||||||
|
|
||||||
|
### 11.1. Commission and Service Inquiries
|
||||||
|
|
||||||
|
For inquiries about professional services or to submit commission requests:
|
||||||
|
|
||||||
|
**Commission Request Form:** [https://forms.nhcarrigan.com/form/xrlqjeu8cbmrta-v0ipoxlupepitlkxtwg70uuciora](https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA)
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Response Time:** Within 48 hours for service inquiries
|
||||||
|
|
||||||
|
### 11.2. General Contact
|
||||||
|
|
||||||
|
For general inquiries about our organisation or services:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
|
## 12. ACKNOWLEDGEMENT AND AGREEMENT
|
||||||
|
|
||||||
|
### 12.1. Policy Acceptance
|
||||||
|
|
||||||
|
By engaging our professional services or submitting commission requests, you acknowledge that you have:
|
||||||
|
**(a)** Read, understood, and agree to comply with this Policy;
|
||||||
|
**(b)** Understood that this Policy does not create binding service agreements;
|
||||||
|
**(c)** Agreed that all professional services require separate written service agreements;
|
||||||
|
**(d)** Acknowledged all disclaimers, limitations, and legal protections incorporated by reference.
|
||||||
|
|
||||||
|
### 12.2. Service Agreement Supremacy
|
||||||
|
|
||||||
|
**IMPORTANT: This Policy provides general information about our professional services. All actual service engagements are governed by separate written service agreements that supersede this Policy and establish binding terms for specific projects.**
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This Professional Services and Commission Policy establishes general terms and information about our professional services offerings. This Policy does not create binding service agreements. All professional service engagements require separate written agreements. For questions about our services, please contact us through the commission request form or at contact@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -2,48 +2,254 @@
|
|||||||
title: Mentorship Programme Terms and Conditions
|
title: Mentorship Programme Terms and Conditions
|
||||||
---
|
---
|
||||||
|
|
||||||
Here at NHCarrigan, we are dedicated to lowering the barriers of entry into tech and helping underprivileged/under-represented classes reach their goals. As part of this mission, we offer a mentorship programme ("Programme"). This Programme operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Policies, and all applicable legal protections by reference.
|
**COMPREHENSIVE TERMS AND CONDITIONS FOR MENTORSHIP PROGRAMME PARTICIPATION**
|
||||||
|
|
||||||
## 1. Introduction
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
These Terms and Conditions (“Terms”) outline the Programme provided by NHCarrigan (“Company”) and apply to all participants enrolled in the Programme. By enrolling, you (the "Mentee") agree to abide by these Terms. The Programme cost is $200 USD per month.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
### 1.1. Enrolment
|
This Mentorship Programme Terms and Conditions ("Terms" or "Agreement") establishes the terms, conditions, and procedures governing participation in the mentorship programme ("Programme") provided by NHCarrigan ("we," "us," "our," or "the Company"). This Agreement operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
|
||||||
|
|
||||||
To enrol in the Programme, [fill out the application](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo).
|
### 1.2. Mission and Purpose
|
||||||
|
|
||||||
## 2. Programme Services
|
We are dedicated to lowering barriers of entry into technology and helping underprivileged and under-represented individuals reach their professional goals. The Programme is designed to provide structured mentorship, educational support, and career development opportunities to participants ("Mentees") who enrol in the Programme.
|
||||||
|
|
||||||
Upon successful enrolment, the Mentee receives the following benefits:
|
### 1.3. Legal Framework Integration
|
||||||
|
|
||||||
### 2.1 Dedicated Discord Channels
|
**IMPORTANT: Comprehensive warranty disclaimers, liability limitations, and all related legal protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all matters related to Programme participation. The Programme is provided "as is" without warranties of any kind.**
|
||||||
|
|
||||||
Participants will have access to private Discord channels exclusively for Mentees. These channels get priority response times from the NHCarrigan team. All participants must adhere to our [Code of Conduct](/community/coc).
|
### 1.4. Scope of Application
|
||||||
|
|
||||||
### 2.3 Flagship Project
|
This Agreement applies to:
|
||||||
|
**(a)** All Mentees enrolled in the Programme;
|
||||||
|
**(b)** All Programme services, benefits, and resources provided to Mentees;
|
||||||
|
**(c)** All interactions between Mentees and Programme staff, mentors, and resources;
|
||||||
|
**(d)** All Programme-related activities, projects, and collaborations.
|
||||||
|
|
||||||
Participants will gain maintainer-level access to a repository under our [Mentorship GitHub organisation](https://github.com/nhcarrigan-mentorship), which they will use to build their flagship project under the tutelage of our team.
|
## 2. ENROLMENT AND PARTICIPATION
|
||||||
|
|
||||||
### 2.4 Career Prep and Resume Building
|
### 2.1. Enrolment Requirements
|
||||||
|
|
||||||
Participants will have the opportunity to build their resumes through an internship with NHCarrigan. This includes eligibility for project contributions and collaboration with the NHCarrigan team.
|
**Enrolment Process:**
|
||||||
|
**(a)** Enrolment in the Programme requires completion of the official [mentorship application form](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo);
|
||||||
|
**(b)** We reserve the right to accept or decline applications at our sole discretion;
|
||||||
|
**(c)** Enrolment is subject to Programme capacity, resource availability, and our assessment of applicant suitability;
|
||||||
|
**(d)** We are not obligated to provide reasons for application rejection.
|
||||||
|
|
||||||
### 2.5 Ongoing Support and Resources
|
### 2.2. Agreement Acceptance
|
||||||
|
|
||||||
Mentees will receive continuous resume reviews, personalized learning roadmaps, and dedicated guidance for the duration of their membership. Additional resources and Programme updates will be provided as part of this lifetime membership support.
|
By enrolling in the Programme, Mentees acknowledge and agree that they have:
|
||||||
|
**(a)** Read, understood, and agree to be bound by these Terms;
|
||||||
|
**(b)** Reviewed and agree to comply with our Community Code of Conduct and all applicable policies;
|
||||||
|
**(c)** Acknowledged all disclaimers, limitations, and legal protections incorporated by reference.
|
||||||
|
|
||||||
## 3. Code of Conduct
|
## 3. PROGRAMME SERVICES AND BENEFITS
|
||||||
|
|
||||||
Participants agree to uphold the Company's Code of Conduct and other policies, as outlined in the [NHCarrigan Documentation](https://docs.nhcarrigan.com/community/coc).
|
### 3.1. Dedicated Discord Channels
|
||||||
|
|
||||||
## 4 Programme Modifications
|
**Channel Access:**
|
||||||
|
**(a)** Mentees receive access to private Discord channels exclusively for Programme participants;
|
||||||
|
**(b)** These channels receive priority response times from our team;
|
||||||
|
**(c)** All participants must adhere to our [Community Code of Conduct](/community/coc) and Programme-specific guidelines;
|
||||||
|
**(d)** We reserve the right to restrict or revoke channel access for violations of community standards or Programme terms.
|
||||||
|
|
||||||
NHCarrigan reserves the right to modify Programme features, benefits, and terms at any time. Notification of such changes will be provided to participants with as much advance notice as possible.
|
### 3.2. Flagship Project Development
|
||||||
|
|
||||||
## 5. Termination and Cancellation
|
**Project Access and Support:**
|
||||||
|
**(a)** Mentees gain maintainer-level access to a repository under our [Mentorship GitHub organisation](https://github.com/NHCarrigan-mentorship);
|
||||||
|
**(b)** Mentees use this repository to build their flagship project under the guidance of our team;
|
||||||
|
**(c)** Project support and guidance are provided subject to mentor availability and Programme resources;
|
||||||
|
**(d)** We do not guarantee specific project outcomes, completion, or success.
|
||||||
|
|
||||||
Participants may cancel their membership at any time, by providing written notice to our team indicating their desire to drop-out and the reason for leaving.
|
### 3.3. Career Preparation and Resume Building
|
||||||
|
|
||||||
## 6. Contact Information
|
**Career Development Services:**
|
||||||
|
**(a)** Mentees have the opportunity to build their resumes through internship-style experiences with NHCarrigan;
|
||||||
|
**(b)** This includes eligibility for project contributions and collaboration with our team;
|
||||||
|
**(c)** Career preparation services are provided for educational and development purposes;
|
||||||
|
**(d)** We do not guarantee employment, job placement, or specific career outcomes.
|
||||||
|
|
||||||
For questions or further information, please contact the NHCarrigan team through the official support channels listed in the [documentation](/about/contact).
|
### 3.4. Ongoing Support and Resources
|
||||||
|
|
||||||
|
**Continuous Support Services:**
|
||||||
|
**(a)** Mentees receive continuous resume reviews, personalised learning roadmaps, and dedicated guidance for the duration of their membership;
|
||||||
|
**(b)** Additional resources and Programme updates are provided as part of membership support;
|
||||||
|
**(c)** Support services are subject to mentor availability and Programme capacity;
|
||||||
|
**(d)** We reserve the right to modify or discontinue specific support services with reasonable notice.
|
||||||
|
|
||||||
|
### 3.5. Service Limitations and Disclaimers
|
||||||
|
|
||||||
|
**IMPORTANT DISCLAIMERS:**
|
||||||
|
**(a)** Programme services are provided "as is" without warranties of any kind;
|
||||||
|
**(b)** We do not guarantee specific learning outcomes, skill development, or career advancement;
|
||||||
|
**(c)** Programme benefits and services may vary based on mentor availability, resource constraints, and Programme capacity;
|
||||||
|
**(d)** We reserve the right to modify Programme features, benefits, and services at any time with reasonable notice.
|
||||||
|
|
||||||
|
## 4. CODE OF CONDUCT AND PARTICIPATION STANDARDS
|
||||||
|
|
||||||
|
### 4.1. Community Standards Compliance
|
||||||
|
|
||||||
|
**Code of Conduct Requirements:**
|
||||||
|
**(a)** All Mentees must comply with our [Community Code of Conduct](/community/coc) and all applicable community policies;
|
||||||
|
**(b)** Violations of community standards may result in Programme suspension or termination;
|
||||||
|
**(c)** We reserve the right to take disciplinary action for conduct that violates community standards or Programme terms;
|
||||||
|
**(d)** Programme participation does not exempt Mentees from community standards or disciplinary procedures.
|
||||||
|
|
||||||
|
### 4.2. Programme Participation Standards
|
||||||
|
|
||||||
|
**Participation Requirements:**
|
||||||
|
**(a)** Mentees are expected to actively engage with Programme resources and activities;
|
||||||
|
**(b)** Mentees must maintain respectful and professional conduct in all Programme interactions;
|
||||||
|
**(c)** Mentees are responsible for their own learning and development progress;
|
||||||
|
**(d)** We reserve the right to terminate Programme participation for failure to meet participation standards.
|
||||||
|
|
||||||
|
## 5. PROGRAMME MODIFICATIONS AND CHANGES
|
||||||
|
|
||||||
|
### 5.1. Right to Modify Programme
|
||||||
|
|
||||||
|
**Modification Authority:**
|
||||||
|
**(a)** We reserve the right to modify Programme features, benefits, terms, and services at any time;
|
||||||
|
**(b)** Significant modifications will be communicated to enrolled Mentees with as much advance notice as possible;
|
||||||
|
**(c)** Modifications may include changes to Programme structure, benefits, fees, or participation requirements;
|
||||||
|
**(d)** Continued Programme participation following modifications constitutes acceptance of modified terms.
|
||||||
|
|
||||||
|
### 5.2. Programme Discontinuation
|
||||||
|
|
||||||
|
**Discontinuation Rights:**
|
||||||
|
**(a)** We reserve the right to discontinue the Programme at any time with reasonable notice to enrolled Mentees;
|
||||||
|
**(b)** In the event of Programme discontinuation, we will provide prorated refunds for unused Programme fees;
|
||||||
|
**(c)** We are not liable for any consequences arising from Programme discontinuation beyond fee refunds;
|
||||||
|
**(d)** Programme discontinuation does not affect accrued obligations or rights established prior to discontinuation.
|
||||||
|
|
||||||
|
## 6. TERMINATION AND CANCELLATION
|
||||||
|
|
||||||
|
### 6.1. Mentee Cancellation Rights
|
||||||
|
|
||||||
|
**Cancellation Process:**
|
||||||
|
**(a)** Mentees may cancel their Programme membership at any time by providing written notice to our team;
|
||||||
|
**(b)** Cancellation notices should indicate the Mentee's desire to withdraw and the reason for leaving;
|
||||||
|
**(c)** Cancellation becomes effective at the end of the current billing period;
|
||||||
|
**(d)** Fees paid for the current billing period are non-refundable upon cancellation.
|
||||||
|
|
||||||
|
### 6.2. Company Termination Rights
|
||||||
|
|
||||||
|
**Termination Authority:**
|
||||||
|
**(a)** We reserve the right to terminate Programme participation for violations of these Terms, Community Code of Conduct, or applicable policies;
|
||||||
|
**(b)** We may terminate Programme participation for non-payment of fees or failure to meet participation standards;
|
||||||
|
**(c)** Termination may be immediate for serious violations or with notice for other circumstances;
|
||||||
|
**(d)** We are not obligated to provide refunds for terminated Programme participation.
|
||||||
|
|
||||||
|
### 6.3. Effect of Termination
|
||||||
|
|
||||||
|
**Post-Termination:**
|
||||||
|
**(a)** Upon termination, Mentees lose access to Programme benefits, channels, and resources;
|
||||||
|
**(b)** Mentees retain ownership of work products created during Programme participation;
|
||||||
|
**(c)** Confidentiality and intellectual property obligations survive termination;
|
||||||
|
**(d)** We are not obligated to provide ongoing support or resources following termination.
|
||||||
|
|
||||||
|
## 7. INTELLECTUAL PROPERTY AND WORK PRODUCT
|
||||||
|
|
||||||
|
### 7.1. Mentee Work Product Ownership
|
||||||
|
|
||||||
|
**Ownership Rights:**
|
||||||
|
**(a)** Mentees retain ownership of work products, projects, and contributions created during Programme participation;
|
||||||
|
**(b)** Work products created in Programme repositories are subject to repository licensing terms;
|
||||||
|
**(c)** We may request permission to showcase Mentee work for Programme promotion and portfolio purposes;
|
||||||
|
**(d)** Mentees grant us a non-exclusive license to use anonymised work products for Programme improvement and promotion.
|
||||||
|
|
||||||
|
### 7.2. Programme Materials and Resources
|
||||||
|
|
||||||
|
**Company Intellectual Property:**
|
||||||
|
**(a)** All Programme materials, resources, and content remain our intellectual property;
|
||||||
|
**(b)** Mentees may use Programme materials for personal learning and development purposes;
|
||||||
|
**(c)** Programme materials may not be redistributed, sold, or used for commercial purposes without permission;
|
||||||
|
**(d)** Unauthorised use of Programme materials may constitute intellectual property infringement.
|
||||||
|
|
||||||
|
## 8. PRIVACY AND DATA PROTECTION
|
||||||
|
|
||||||
|
### 8.1. Information Collection and Use
|
||||||
|
|
||||||
|
**Data Handling:**
|
||||||
|
**(a)** Mentee information is collected and processed in accordance with our Privacy Policy;
|
||||||
|
**(b)** We collect information necessary for Programme administration, support, and improvement;
|
||||||
|
**(c)** Mentee information is not shared with third parties except as necessary for Programme provision or as required by law;
|
||||||
|
**(d)** Mentees may request access to or deletion of their personal information in accordance with our Privacy Policy.
|
||||||
|
|
||||||
|
### 8.2. Programme Communications
|
||||||
|
|
||||||
|
**Communication Practices:**
|
||||||
|
**(a)** Programme communications may include email, Discord messages, and other digital channels;
|
||||||
|
**(b)** Mentees consent to receive Programme-related communications;
|
||||||
|
**(c)** Communications are subject to our Privacy Policy and data protection practices;
|
||||||
|
**(d)** Mentees may opt out of non-essential communications while remaining enrolled in the Programme.
|
||||||
|
|
||||||
|
## 9. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 9.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, maximum liability caps, and all related legal protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all matters related to Programme participation.**
|
||||||
|
|
||||||
|
### 9.2. Programme-Specific Disclaimers
|
||||||
|
|
||||||
|
**Additional Limitations:**
|
||||||
|
**(a)** We are not liable for Mentee learning outcomes, career advancement, or professional success;
|
||||||
|
**(b)** We do not guarantee job placement, employment opportunities, or specific career outcomes;
|
||||||
|
**(c)** We are not responsible for Mentee decisions made based on Programme guidance or resources;
|
||||||
|
**(d)** Our liability is limited to the maximum extent permitted by applicable law and Programme fees paid.
|
||||||
|
|
||||||
|
## 10. PAYMENT TERMS AND REFUND POLICY
|
||||||
|
|
||||||
|
### 10.1. Payment Obligations
|
||||||
|
|
||||||
|
**Payment Requirements:**
|
||||||
|
**(a)** Programme fees are due in advance on a monthly basis;
|
||||||
|
**(b)** Payments must be made through designated payment methods;
|
||||||
|
**(c)** Failure to pay fees may result in Programme suspension or termination;
|
||||||
|
**(d)** We reserve the right to modify payment terms with reasonable notice.
|
||||||
|
|
||||||
|
### 10.2. Refund Policy
|
||||||
|
|
||||||
|
**Refund Terms:**
|
||||||
|
**(a)** Programme fees are generally non-refundable;
|
||||||
|
**(b)** Refunds may be provided for Programme discontinuation or our failure to provide agreed services;
|
||||||
|
**(c)** Refund requests must be submitted in writing and are subject to our review and approval;
|
||||||
|
**(d)** Processing fees charged by payment platforms are non-refundable.
|
||||||
|
|
||||||
|
## 11. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
|
### 11.1. Programme Inquiries
|
||||||
|
|
||||||
|
For questions about the Programme or to submit cancellation notices:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Response Time:** Within 48 hours for Programme-related inquiries
|
||||||
|
|
||||||
|
### 11.2. General Contact
|
||||||
|
|
||||||
|
For general inquiries about our organisation or services:
|
||||||
|
|
||||||
|
**Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
|
**Support Channels:** As specified in our [Contact Policy](/about/contact)
|
||||||
|
|
||||||
|
## 12. ACKNOWLEDGEMENT AND AGREEMENT
|
||||||
|
|
||||||
|
### 12.1. Terms Acceptance
|
||||||
|
|
||||||
|
By enrolling in the Programme, Mentees acknowledge that they have:
|
||||||
|
**(a)** Read, understood, and agree to be bound by these Terms;
|
||||||
|
**(b)** Reviewed and agree to comply with all applicable policies and community standards;
|
||||||
|
**(c)** Understood the Programme fees, payment obligations, and refund policy;
|
||||||
|
**(d)** Acknowledged all disclaimers, limitations, and legal protections incorporated by reference.
|
||||||
|
|
||||||
|
### 12.2. Entire Agreement
|
||||||
|
|
||||||
|
These Terms, together with all incorporated policies and agreements, constitute the entire agreement between Mentees and the Company regarding Programme participation and supersede all prior agreements and understandings.
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This Mentorship Programme Terms and Conditions establishes the terms governing participation in our mentorship programme. By enrolling in the Programme, you acknowledge that you have read, understood, and agree to be bound by these Terms. For questions about the Programme, please contact us at contact@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ This Mission Statement ("Statement") articulates the core values and guiding pri
|
|||||||
|
|
||||||
### 1.1. Commitment to Inclusivity
|
### 1.1. Commitment to Inclusivity
|
||||||
|
|
||||||
The Company shall actively work to dismantle barriers and promote diversity in all areas of its operations. We seek to create spaces where all individuals, particularly from marginalized communities, feel supported and valued.
|
The Company shall actively work to dismantle barriers and promote diversity in all areas of its operations. We seek to create spaces where all individuals, particularly from marginalised communities, feel supported and valued.
|
||||||
|
|
||||||
### 1.2. Sustainability as a Priority
|
### 1.2. Sustainability as a Priority
|
||||||
|
|
||||||
Environmental sustainability is integral to the Company's mission. We shall consistently minimize our carbon footprint, use eco-friendly technologies, and ensure that every project aligns with our environmental goals.
|
Environmental sustainability is integral to the Company's mission. We shall consistently minimise our carbon footprint, use eco-friendly technologies, and ensure that every project aligns with our environmental goals.
|
||||||
|
|
||||||
### 1.3. Ethical Responsibility
|
### 1.3. Ethical Responsibility
|
||||||
|
|
||||||
@@ -32,15 +32,15 @@ The Company is committed to tearing down the systemic and social barriers that e
|
|||||||
|
|
||||||
### 1.7. Challenging Toxic Behaviors
|
### 1.7. Challenging Toxic Behaviors
|
||||||
|
|
||||||
We recognize that toxic behaviors and exclusionary practices harm communities. The Company shall take a proactive stance in challenging these behaviors within our industry and within the tech communities we interact with, fostering spaces where collaboration, respect, and growth thrive.
|
We recognise that toxic behaviours and exclusionary practices harm communities. The Company shall take a proactive stance in challenging these behaviours within our industry and within the tech communities we interact with, fostering spaces where collaboration, respect, and growth thrive.
|
||||||
|
|
||||||
### 1.8. Comprehensive Community Support and Member Welfare
|
### 1.8. Comprehensive Community Support and Member Welfare
|
||||||
|
|
||||||
The Company is dedicated to providing comprehensive support systems for community members, including mentorship for new developers, recognition and appreciation programs, and robust member welfare frameworks. Through guided mentorship, educational resources, crisis response systems, and hands-on support, we help individuals thrive within our communities and succeed in the tech industry, particularly focusing on support for underrepresented groups.
|
The Company is dedicated to providing comprehensive support systems for community members, including mentorship for new developers, recognition and appreciation programmes, and robust member welfare frameworks. Through guided mentorship, educational resources, crisis response systems, and hands-on support, we help individuals thrive within our communities and succeed in the tech industry, particularly focusing on support for underrepresented groups.
|
||||||
|
|
||||||
## 2. Strategic Goals
|
## 2. Strategic Goals
|
||||||
|
|
||||||
### 2.1. Elevating Marginalized Voices
|
### 2.1. Elevating Marginalised Voices
|
||||||
|
|
||||||
The Company is committed to using its platform to elevate the voices and contributions of individuals from underrepresented communities in tech and beyond.
|
The Company is committed to using its platform to elevate the voices and contributions of individuals from underrepresented communities in tech and beyond.
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ We will continue to build and expand initiatives aimed at mentoring and supporti
|
|||||||
|
|
||||||
### 3.1. Right to Amend
|
### 3.1. Right to Amend
|
||||||
|
|
||||||
The Company reserves the right to amend this Statement as necessary to reflect evolving best practices and organizational goals.
|
The Company reserves the right to amend this Statement as necessary to reflect evolving best practices and organisational goals.
|
||||||
|
|
||||||
### 3.2. Notification of Changes
|
### 3.2. Notification of Changes
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Environmental Impact Commitment
|
title: Environmental Impact Commitment
|
||||||
---
|
---
|
||||||
|
|
||||||
This Environmental Impact Commitment ("Commitment") outlines the principles and obligations that NHCarrigan ("The Company") upholds to minimize its environmental impact and contribute to global sustainability efforts. This Commitment operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Mission Statement, and all applicable legal protections by reference.
|
This Environmental Impact Commitment ("Commitment") outlines the principles and obligations that NHCarrigan ("The Company") upholds to minimise its environmental impact and contribute to global sustainability efforts. This Commitment operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Mission Statement, and all applicable legal protections by reference.
|
||||||
|
|
||||||
## 1. Definitions
|
## 1. Definitions
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ A situation where the environmental harm caused by a project or activity exceeds
|
|||||||
|
|
||||||
### 2.1. Commitment to Sustainability
|
### 2.1. Commitment to Sustainability
|
||||||
|
|
||||||
The Company is committed to sustainability at all levels of its operations, actively seeking to minimize its environmental impact and promote long-term environmental health.
|
The Company is committed to sustainability at all levels of its operations, actively seeking to minimise its environmental impact and promote long-term environmental health.
|
||||||
|
|
||||||
### 2.2. Prioritization of Environmental Impact
|
### 2.2. Prioritization of Environmental Impact
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ Environmental considerations, including carbon footprint and resource consumptio
|
|||||||
|
|
||||||
### 2.3. Responsible Technology Use
|
### 2.3. Responsible Technology Use
|
||||||
|
|
||||||
The Company shall only utilize technologies that align with its environmental goals, ensuring minimal energy consumption and environmental degradation.
|
The Company shall only utilise technologies that align with its environmental goals, ensuring minimal energy consumption and environmental degradation.
|
||||||
|
|
||||||
## 3. Carbon Offsetting
|
## 3. Carbon Offsetting
|
||||||
|
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ title: Community Disciplinary Appeals Policy
|
|||||||
|
|
||||||
## 1. Preamble and Purpose
|
## 1. Preamble and Purpose
|
||||||
|
|
||||||
### 1.1 Introduction
|
### 1.1. Introduction
|
||||||
|
|
||||||
This Community Disciplinary Appeals Policy (hereinafter referred to as "the Policy") establishes the formal procedures and requirements for appealing disciplinary sanctions imposed by our moderation team. Whilst our Community Leaders exercise careful discretion and professional judgement when implementing disciplinary measures, we acknowledge that human error or misunderstandings may occasionally occur within any moderation system.
|
This Community Disciplinary Appeals Policy (hereinafter referred to as "the Policy") establishes the formal procedures and requirements for appealing disciplinary sanctions imposed by our moderation team. Whilst our Community Leaders exercise careful discretion and professional judgement when implementing disciplinary measures, we acknowledge that human error or misunderstandings may occasionally occur within any moderation system.
|
||||||
|
|
||||||
### 1.2 Purpose and Scope
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
This Policy serves to:
|
This Policy serves to:
|
||||||
- Provide a fair and transparent mechanism for reviewing disciplinary decisions
|
- Provide a fair and transparent mechanism for reviewing disciplinary decisions
|
||||||
@@ -16,13 +16,13 @@ This Policy serves to:
|
|||||||
- Maintain the integrity of our community standards whilst protecting individual rights
|
- Maintain the integrity of our community standards whilst protecting individual rights
|
||||||
- Establish clear procedures for both appellants and review panels
|
- Establish clear procedures for both appellants and review panels
|
||||||
|
|
||||||
### 1.3 Right of Appeal
|
### 1.3. Right of Appeal
|
||||||
|
|
||||||
Every community member who receives a disciplinary sanction has the fundamental right to appeal such decision through the procedures outlined herein, subject to the conditions and limitations specified in this Policy.
|
Every community member who receives a disciplinary sanction has the fundamental right to appeal such decision through the procedures outlined herein, subject to the conditions and limitations specified in this Policy.
|
||||||
|
|
||||||
## 2. Definitions and Interpretation
|
## 2. Definitions and Interpretation
|
||||||
|
|
||||||
### 2.1 Key Definitions
|
### 2.1. Key Definitions
|
||||||
|
|
||||||
For the purposes of this Policy:
|
For the purposes of this Policy:
|
||||||
- **"Appellant"** means any individual seeking to appeal a disciplinary sanction
|
- **"Appellant"** means any individual seeking to appeal a disciplinary sanction
|
||||||
@@ -31,13 +31,13 @@ For the purposes of this Policy:
|
|||||||
- **"Original Decision"** means the initial disciplinary action being appealed
|
- **"Original Decision"** means the initial disciplinary action being appealed
|
||||||
- **"Community Leaders"** means moderators, administrators, and other authorised personnel
|
- **"Community Leaders"** means moderators, administrators, and other authorised personnel
|
||||||
|
|
||||||
### 2.2 Interpretation
|
### 2.2. Interpretation
|
||||||
|
|
||||||
This Policy shall be interpreted in accordance with principles of fairness, natural justice, and the overarching objectives of maintaining community safety and standards.
|
This Policy shall be interpreted in accordance with principles of fairness, natural justice, and the overarching objectives of maintaining community safety and standards.
|
||||||
|
|
||||||
## 3. Grounds for Appeal
|
## 3. Grounds for Appeal
|
||||||
|
|
||||||
### 3.1 Acceptable Grounds
|
### 3.1. Acceptable Grounds
|
||||||
|
|
||||||
Appeals may be submitted on the following grounds:
|
Appeals may be submitted on the following grounds:
|
||||||
1. **Procedural Irregularity**: The disciplinary process was not followed correctly
|
1. **Procedural Irregularity**: The disciplinary process was not followed correctly
|
||||||
@@ -46,7 +46,7 @@ Appeals may be submitted on the following grounds:
|
|||||||
4. **New Evidence**: Relevant evidence has become available that was not considered in the original decision
|
4. **New Evidence**: Relevant evidence has become available that was not considered in the original decision
|
||||||
5. **Misinterpretation of Policy**: The community guidelines or terms of service were incorrectly applied
|
5. **Misinterpretation of Policy**: The community guidelines or terms of service were incorrectly applied
|
||||||
|
|
||||||
### 3.2 Inadmissible Appeals
|
### 3.2. Inadmissible Appeals
|
||||||
|
|
||||||
Appeals will not be considered on the following grounds:
|
Appeals will not be considered on the following grounds:
|
||||||
1. General disagreement with community policies or guidelines
|
1. General disagreement with community policies or guidelines
|
||||||
@@ -56,7 +56,7 @@ Appeals will not be considered on the following grounds:
|
|||||||
|
|
||||||
## 4. Pre-Appeal Requirements
|
## 4. Pre-Appeal Requirements
|
||||||
|
|
||||||
### 4.1 Mandatory Preparation
|
### 4.1. Mandatory Preparation
|
||||||
|
|
||||||
Prior to submitting an appeal, appellants must complete the following preparatory steps:
|
Prior to submitting an appeal, appellants must complete the following preparatory steps:
|
||||||
|
|
||||||
@@ -69,7 +69,7 @@ Prior to submitting an appeal, appellants must complete the following preparator
|
|||||||
|
|
||||||
3. **Self-Assessment**: Complete a comprehensive self-assessment of the circumstances leading to the sanction
|
3. **Self-Assessment**: Complete a comprehensive self-assessment of the circumstances leading to the sanction
|
||||||
|
|
||||||
### 4.2 Required Documentation
|
### 4.2. Required Documentation
|
||||||
|
|
||||||
Appeals must include the following information:
|
Appeals must include the following information:
|
||||||
1. **Identity Verification**: Full account details and contact information
|
1. **Identity Verification**: Full account details and contact information
|
||||||
@@ -81,11 +81,11 @@ Appeals must include the following information:
|
|||||||
|
|
||||||
## 5. Appeal Submission Procedures
|
## 5. Appeal Submission Procedures
|
||||||
|
|
||||||
### 5.1 Formal Submission Process
|
### 5.1. Formal Submission Process
|
||||||
|
|
||||||
Appeals must be submitted through our official appeals portal: [Community Appeals Form](https://forms.nhcarrigan.com/form/l3PC15yalSWjdZASTQvGo22q_uj_7OtXAhZdcW35ev8)
|
Appeals must be submitted through our official appeals portal: [Community Appeals Form](https://forms.nhcarrigan.com/form/l3PC15yalSWjdZASTQvGo22q_uj_7OtXAhZdcW35ev8)
|
||||||
|
|
||||||
### 5.2 Submission Requirements
|
### 5.2. Submission Requirements
|
||||||
|
|
||||||
All appeals must:
|
All appeals must:
|
||||||
- Be submitted within thirty (30) days of the original sanction
|
- Be submitted within thirty (30) days of the original sanction
|
||||||
@@ -93,7 +93,7 @@ All appeals must:
|
|||||||
- Be written in clear, professional language
|
- Be written in clear, professional language
|
||||||
- Demonstrate good faith engagement with the appeals process
|
- Demonstrate good faith engagement with the appeals process
|
||||||
|
|
||||||
### 5.3 Multiple Appeal Prohibition
|
### 5.3. Multiple Appeal Prohibition
|
||||||
|
|
||||||
:::caution[Critical Warning]
|
:::caution[Critical Warning]
|
||||||
Submitting multiple appeals for the same disciplinary sanction will result in automatic dismissal of all subsequent appeals and may constitute abuse of process, potentially leading to additional sanctions.
|
Submitting multiple appeals for the same disciplinary sanction will result in automatic dismissal of all subsequent appeals and may constitute abuse of process, potentially leading to additional sanctions.
|
||||||
@@ -101,7 +101,7 @@ Submitting multiple appeals for the same disciplinary sanction will result in au
|
|||||||
|
|
||||||
## 6. Review Process and Procedures
|
## 6. Review Process and Procedures
|
||||||
|
|
||||||
### 6.1 Initial Review
|
### 6.1. Initial Review
|
||||||
|
|
||||||
Upon receipt, all appeals undergo an initial administrative review to ensure:
|
Upon receipt, all appeals undergo an initial administrative review to ensure:
|
||||||
- Compliance with submission requirements
|
- Compliance with submission requirements
|
||||||
@@ -109,7 +109,7 @@ Upon receipt, all appeals undergo an initial administrative review to ensure:
|
|||||||
- Completeness of documentation
|
- Completeness of documentation
|
||||||
- Identification of appropriate grounds for appeal
|
- Identification of appropriate grounds for appeal
|
||||||
|
|
||||||
### 6.2 Substantive Review
|
### 6.2. Substantive Review
|
||||||
|
|
||||||
Appeals meeting initial requirements proceed to substantive review, wherein the Appeals Panel shall:
|
Appeals meeting initial requirements proceed to substantive review, wherein the Appeals Panel shall:
|
||||||
1. Examine all evidence and documentation
|
1. Examine all evidence and documentation
|
||||||
@@ -117,13 +117,13 @@ Appeals meeting initial requirements proceed to substantive review, wherein the
|
|||||||
3. Consider the appellant's submissions and arguments
|
3. Consider the appellant's submissions and arguments
|
||||||
4. Assess whether the appeal has merit under the established grounds
|
4. Assess whether the appeal has merit under the established grounds
|
||||||
|
|
||||||
### 6.3 Review Timeline
|
### 6.3. Review Timeline
|
||||||
|
|
||||||
The Appeals Panel endeavours to complete reviews within fourteen (14) business days of receipt, though complex cases may require additional time.
|
The Appeals Panel endeavours to complete reviews within fourteen (14) business days of receipt, though complex cases may require additional time.
|
||||||
|
|
||||||
## 7. Possible Outcomes and Decisions
|
## 7. Possible Outcomes and Decisions
|
||||||
|
|
||||||
### 7.1 Appeal Outcomes
|
### 7.1. Appeal Outcomes
|
||||||
|
|
||||||
Following review, the Appeals Panel may:
|
Following review, the Appeals Panel may:
|
||||||
1. **Uphold the Appeal**: Overturn the original sanction entirely
|
1. **Uphold the Appeal**: Overturn the original sanction entirely
|
||||||
@@ -131,7 +131,7 @@ Following review, the Appeals Panel may:
|
|||||||
3. **Dismiss the Appeal**: Confirm the original sanction remains in full effect
|
3. **Dismiss the Appeal**: Confirm the original sanction remains in full effect
|
||||||
4. **Remit for Reconsideration**: Return the matter for fresh consideration with specific directions
|
4. **Remit for Reconsideration**: Return the matter for fresh consideration with specific directions
|
||||||
|
|
||||||
### 7.2 Decision Communication
|
### 7.2. Decision Communication
|
||||||
|
|
||||||
All appeal decisions shall be communicated in writing to the appellant, including:
|
All appeal decisions shall be communicated in writing to the appellant, including:
|
||||||
- The outcome of the appeal
|
- The outcome of the appeal
|
||||||
@@ -141,11 +141,11 @@ All appeal decisions shall be communicated in writing to the appellant, includin
|
|||||||
|
|
||||||
## 8. Finality and Limitations
|
## 8. Finality and Limitations
|
||||||
|
|
||||||
### 8.1 Decision Finality
|
### 8.1. Decision Finality
|
||||||
|
|
||||||
Decisions of the Appeals Panel are final and binding. No further appeals or reviews are available through our internal processes.
|
Decisions of the Appeals Panel are final and binding. No further appeals or reviews are available through our internal processes.
|
||||||
|
|
||||||
### 8.2 Discretionary Rights Reserved
|
### 8.2. Discretionary Rights Reserved
|
||||||
|
|
||||||
Notwithstanding this appeals process, we reserve the absolute right to:
|
Notwithstanding this appeals process, we reserve the absolute right to:
|
||||||
- Deny or revoke access to our services at any time
|
- Deny or revoke access to our services at any time
|
||||||
@@ -153,7 +153,7 @@ Notwithstanding this appeals process, we reserve the absolute right to:
|
|||||||
- Take additional action based on new information or circumstances
|
- Take additional action based on new information or circumstances
|
||||||
- Refuse service to any individual at our sole discretion
|
- Refuse service to any individual at our sole discretion
|
||||||
|
|
||||||
### 8.3 Abuse of Process
|
### 8.3. Abuse of Process
|
||||||
|
|
||||||
Repeated abuse of the appeals process, including but not limited to:
|
Repeated abuse of the appeals process, including but not limited to:
|
||||||
- Submitting frivolous or vexatious appeals
|
- Submitting frivolous or vexatious appeals
|
||||||
@@ -165,7 +165,7 @@ May result in permanent ineligibility for future appeals and additional discipli
|
|||||||
|
|
||||||
## 9. Compliance and Acknowledgement
|
## 9. Compliance and Acknowledgement
|
||||||
|
|
||||||
### 9.1 Terms Acceptance
|
### 9.1. Terms Acceptance
|
||||||
|
|
||||||
By submitting an appeal through this process, appellants explicitly acknowledge that they have:
|
By submitting an appeal through this process, appellants explicitly acknowledge that they have:
|
||||||
- Read and understood this Appeals Policy in its entirety
|
- Read and understood this Appeals Policy in its entirety
|
||||||
@@ -173,7 +173,7 @@ By submitting an appeal through this process, appellants explicitly acknowledge
|
|||||||
- Agreed to accept the decision of the Appeals Panel as final and binding
|
- Agreed to accept the decision of the Appeals Panel as final and binding
|
||||||
- Committed to full compliance with all community standards upon any reinstatement
|
- Committed to full compliance with all community standards upon any reinstatement
|
||||||
|
|
||||||
### 9.2 Legal Framework Integration
|
### 9.2. Legal Framework Integration
|
||||||
|
|
||||||
This appeals process operates within our comprehensive legal and policy framework, including:
|
This appeals process operates within our comprehensive legal and policy framework, including:
|
||||||
|
|
||||||
@@ -183,20 +183,20 @@ This appeals process operates within our comprehensive legal and policy framewor
|
|||||||
|
|
||||||
**(c)** **Content and Moderation Policy**: Enforcement procedures and standards;
|
**(c)** **Content and Moderation Policy**: Enforcement procedures and standards;
|
||||||
|
|
||||||
**(d)** **All applicable policies**: Privacy, acceptable use, and specialized policies incorporated by reference.
|
**(d)** **All applicable policies**: Privacy, acceptable use, and specialised policies incorporated by reference.
|
||||||
|
|
||||||
**IMPORTANT**: This appeals process is provided as an internal community service and does not create any legal rights or obligations beyond those established in our comprehensive legal policies. The availability of this process does not limit our right to take any action deemed necessary for community safety and integrity.
|
**IMPORTANT**: This appeals process is provided as an internal community service and does not create any legal rights or obligations beyond those established in our comprehensive legal policies. The availability of this process does not limit our right to take any action deemed necessary for community safety and integrity.
|
||||||
|
|
||||||
## 10. Policy Updates and Amendments
|
## 10. Policy Updates and Amendments
|
||||||
|
|
||||||
### 10.1 Amendment Rights
|
### 10.1. Amendment Rights
|
||||||
|
|
||||||
This Policy may be updated, modified, or amended at any time without prior notice. Appellants are responsible for ensuring familiarity with the current version of this Policy.
|
This Policy may be updated, modified, or amended at any time without prior notice. Appellants are responsible for ensuring familiarity with the current version of this Policy.
|
||||||
|
|
||||||
### 10.2 Effective Date
|
### 10.2. Policy Implementation
|
||||||
|
|
||||||
This Policy is effective immediately upon publication and applies to all appeals submitted after its implementation.
|
This Policy applies to all appeals submitted after its implementation.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Community Disciplinary Appeals Policy was last updated on 15 September 2025 and supersedes all previous versions.*
|
*This Community Disciplinary Appeals Policy.*
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ title: Community Code of Conduct
|
|||||||
|
|
||||||
## 1. Preamble and Foundational Principles
|
## 1. Preamble and Foundational Principles
|
||||||
|
|
||||||
### 1.1 Introduction and Purpose
|
### 1.1. Introduction and Purpose
|
||||||
|
|
||||||
This Community Code of Conduct (hereinafter referred to as "the Code") establishes the fundamental standards of behaviour and conduct expected from all individuals participating in our community ecosystem. This Code serves as the cornerstone of our commitment to fostering an inclusive, safe, and productive environment wherein all members can participate meaningfully and contribute positively to our collective objectives.
|
This Community Code of Conduct (hereinafter referred to as "the Code") establishes the fundamental standards of behaviour and conduct expected from all individuals participating in our community ecosystem. This Code serves as the cornerstone of our commitment to fostering an inclusive, safe, and productive environment wherein all members can participate meaningfully and contribute positively to our collective objectives.
|
||||||
|
|
||||||
### 1.2 Fundamental Values
|
### 1.2. Fundamental Values
|
||||||
|
|
||||||
Our community is built upon the following core principles:
|
Our community is built upon the following core principles:
|
||||||
- **Respect and Dignity**: Every individual deserves to be treated with courtesy, respect, and human dignity
|
- **Respect and Dignity**: Every individual deserves to be treated with courtesy, respect, and human dignity
|
||||||
@@ -17,7 +17,7 @@ Our community is built upon the following core principles:
|
|||||||
- **Constructive Collaboration**: We encourage productive dialogue, constructive criticism, and collaborative problem-solving
|
- **Constructive Collaboration**: We encourage productive dialogue, constructive criticism, and collaborative problem-solving
|
||||||
- **Transparency and Accountability**: We operate with openness, honesty, and accept responsibility for our actions and decisions
|
- **Transparency and Accountability**: We operate with openness, honesty, and accept responsibility for our actions and decisions
|
||||||
|
|
||||||
### 1.3 Legal Framework and Policy Integration
|
### 1.3. Legal Framework and Policy Integration
|
||||||
|
|
||||||
This Code operates within and supplements our comprehensive legal and policy framework, including:
|
This Code operates within and supplements our comprehensive legal and policy framework, including:
|
||||||
|
|
||||||
@@ -31,17 +31,17 @@ This Code operates within and supplements our comprehensive legal and policy fra
|
|||||||
|
|
||||||
**(e)** **Limitation of Liability and Indemnification Policy**: Legal protections and risk allocation;
|
**(e)** **Limitation of Liability and Indemnification Policy**: Legal protections and risk allocation;
|
||||||
|
|
||||||
**(f)** **All other applicable legal policies**: Export control, service level agreements, and specialized policies.
|
**(f)** **All other applicable legal policies**: Export control, service level agreements, and specialised policies.
|
||||||
|
|
||||||
**IMPORTANT**: Where this Code overlaps with our comprehensive legal policies, users are subject to both sets of requirements. For detailed enforcement procedures, content moderation standards, and legal protections, refer to the applicable specialized policies incorporated by reference.
|
**IMPORTANT**: Where this Code overlaps with our comprehensive legal policies, users are subject to both sets of requirements. For detailed enforcement procedures, content moderation standards, and legal protections, refer to the applicable specialised policies incorporated by reference.
|
||||||
|
|
||||||
## 2. Definitions and Scope of Application
|
## 2. Definitions and Scope of Application
|
||||||
|
|
||||||
### 2.1 Comprehensive Definitions
|
### 2.1. Comprehensive Definitions
|
||||||
|
|
||||||
For the purposes of this Code, the following definitions shall apply:
|
For the purposes of this Code, the following definitions shall apply:
|
||||||
|
|
||||||
#### 2.1.1 Community Ecosystem
|
#### 2.1.1. Community Ecosystem
|
||||||
**"Our Community"** encompasses all platforms, spaces, and environments, whether digital, physical, or hybrid, where members interact under our organisation's auspices, including but not limited to:
|
**"Our Community"** encompasses all platforms, spaces, and environments, whether digital, physical, or hybrid, where members interact under our organisation's auspices, including but not limited to:
|
||||||
- Official Discord servers and communication platforms
|
- Official Discord servers and communication platforms
|
||||||
- Code repositories, version control systems, and development platforms
|
- Code repositories, version control systems, and development platforms
|
||||||
@@ -52,7 +52,7 @@ For the purposes of this Code, the following definitions shall apply:
|
|||||||
- Virtual events, webinars, and online presentations
|
- Virtual events, webinars, and online presentations
|
||||||
- Any other platform officially endorsed, managed, or sponsored by our organisation
|
- Any other platform officially endorsed, managed, or sponsored by our organisation
|
||||||
|
|
||||||
#### 2.1.2 Community Participants
|
#### 2.1.2. Community Participants
|
||||||
**"Community Members"** refers to all individuals who participate in Our Community, regardless of their role, level of engagement, or duration of participation, including:
|
**"Community Members"** refers to all individuals who participate in Our Community, regardless of their role, level of engagement, or duration of participation, including:
|
||||||
- Casual users and occasional participants
|
- Casual users and occasional participants
|
||||||
- Regular contributors and active members
|
- Regular contributors and active members
|
||||||
@@ -61,7 +61,7 @@ For the purposes of this Code, the following definitions shall apply:
|
|||||||
- Administrative staff and organisational representatives
|
- Administrative staff and organisational representatives
|
||||||
- Guest speakers, invited participants, and temporary contributors
|
- Guest speakers, invited participants, and temporary contributors
|
||||||
|
|
||||||
#### 2.1.3 Leadership and Authority
|
#### 2.1.3. Leadership and Authority
|
||||||
**"Community Leaders"** refers to individuals vested with official responsibilities, authority, and trust within Our Community, including:
|
**"Community Leaders"** refers to individuals vested with official responsibilities, authority, and trust within Our Community, including:
|
||||||
- Community moderators and content moderators
|
- Community moderators and content moderators
|
||||||
- Technical administrators and system administrators
|
- Technical administrators and system administrators
|
||||||
@@ -70,38 +70,38 @@ For the purposes of this Code, the following definitions shall apply:
|
|||||||
- Event organisers and programme coordinators
|
- Event organisers and programme coordinators
|
||||||
- Senior administrators and executive leadership
|
- Senior administrators and executive leadership
|
||||||
|
|
||||||
#### 2.1.4 Conduct and Violations
|
#### 2.1.4. Conduct and Violations
|
||||||
**"Code of Conduct Violation"** means any behaviour, action, or communication that contravenes the guidelines, standards, and principles outlined in this Code or its associated policies.
|
**"Code of Conduct Violation"** means any behaviour, action, or communication that contravenes the guidelines, standards, and principles outlined in this Code or its associated policies.
|
||||||
|
|
||||||
**"Reporting"** refers to the formal process of bringing potential Code of Conduct violations to the attention of Community Leaders through officially designated channels and procedures.
|
**"Reporting"** refers to the formal process of bringing potential Code of Conduct violations to the attention of Community Leaders through officially designated channels and procedures.
|
||||||
|
|
||||||
**"Disciplinary Sanctions"** means the consequences, penalties, or corrective measures imposed upon community members who violate this Code, as determined by Community Leaders in accordance with established procedures.
|
**"Disciplinary Sanctions"** means the consequences, penalties, or corrective measures imposed upon community members who violate this Code, as determined by Community Leaders in accordance with established procedures.
|
||||||
|
|
||||||
### 2.2 Territorial and Temporal Scope
|
### 2.2. Territorial and Temporal Scope
|
||||||
|
|
||||||
#### 2.2.1 Primary Application
|
#### 2.2.1. Primary Application
|
||||||
This Code applies directly and immediately to all interactions, communications, and behaviours occurring within Our Community spaces, including:
|
This Code applies directly and immediately to all interactions, communications, and behaviours occurring within Our Community spaces, including:
|
||||||
- Public channels, forums, and discussion areas
|
- Public channels, forums, and discussion areas
|
||||||
- Private channels, direct messages, and personal communications conducted through community platforms
|
- Private channels, direct messages, and personal communications conducted through community platforms
|
||||||
- Online and offline community-organised events and activities
|
- Online and offline community-organised events and activities
|
||||||
- Any communication using official community branding, accounts, or platforms
|
- Any communication using official community branding, accounts, or platforms
|
||||||
|
|
||||||
#### 2.2.2 Extended Application
|
#### 2.2.2. Extended Application
|
||||||
This Code may also extend to interactions and behaviours occurring outside Our Community spaces when such conduct:
|
This Code may also extend to interactions and behaviours occurring outside Our Community spaces when such conduct:
|
||||||
- Involves multiple Community Members in a manner that affects community relationships or dynamics
|
- Involves multiple Community Members in a manner that affects community relationships or dynamics
|
||||||
- Has a substantial, demonstrable impact on the well-being, safety, or participation of Community Members
|
- Has a substantial, demonstrable impact on the well-being, safety, or participation of Community Members
|
||||||
- Significantly affects the reputation, integrity, or safety of Our Community or its members
|
- Significantly affects the reputation, integrity, or safety of Our Community or its members
|
||||||
- Constitutes harassment, threats, or other harmful behaviour directed at Community Members
|
- Constitutes harassment, threats, or other harmful behaviour directed at Community Members
|
||||||
|
|
||||||
#### 2.2.3 Temporal Considerations
|
#### 2.2.3. Temporal Considerations
|
||||||
This Code applies to:
|
This Code applies to:
|
||||||
- All current and ongoing interactions within Our Community
|
- All current and ongoing interactions within Our Community
|
||||||
- Past behaviour and conduct of Community Members, including actions that occurred prior to joining Our Community
|
- Past behaviour and conduct of Community Members, including actions that occurred prior to joining Our Community
|
||||||
- Patterns of behaviour that may have commenced before participation in Our Community but continue to affect community dynamics
|
- Patterns of behaviour that may have commenced before participation in Our Community but continue to affect community dynamics
|
||||||
|
|
||||||
### 2.3 Reporting Framework
|
### 2.3. Reporting Framework
|
||||||
|
|
||||||
#### 2.3.1 Reporting Obligations and Encouragement
|
#### 2.3.1. Reporting Obligations and Encouragement
|
||||||
We strongly encourage the reporting of any violations of this Code, including but not limited to:
|
We strongly encourage the reporting of any violations of this Code, including but not limited to:
|
||||||
- Harassment, discrimination, or threats directed at Community Members
|
- Harassment, discrimination, or threats directed at Community Members
|
||||||
- Violations committed by Community Leaders or individuals in positions of authority
|
- Violations committed by Community Leaders or individuals in positions of authority
|
||||||
@@ -109,7 +109,7 @@ We strongly encourage the reporting of any violations of this Code, including bu
|
|||||||
- Historical incidents, regardless of when they occurred
|
- Historical incidents, regardless of when they occurred
|
||||||
- Patterns of concerning behaviour that may not constitute individual violations but collectively create problems
|
- Patterns of concerning behaviour that may not constitute individual violations but collectively create problems
|
||||||
|
|
||||||
#### 2.3.2 Community Leader Responsibilities
|
#### 2.3.2. Community Leader Responsibilities
|
||||||
Community Leaders commit to the following standards in handling reports:
|
Community Leaders commit to the following standards in handling reports:
|
||||||
- Treat all good-faith reports with seriousness, confidentiality, and respect
|
- Treat all good-faith reports with seriousness, confidentiality, and respect
|
||||||
- Protect the privacy, safety, and security of all report submitters
|
- Protect the privacy, safety, and security of all report submitters
|
||||||
@@ -120,35 +120,35 @@ Community Leaders commit to the following standards in handling reports:
|
|||||||
|
|
||||||
## 3. Standards of Acceptable Conduct
|
## 3. Standards of Acceptable Conduct
|
||||||
|
|
||||||
### 3.1 Positive Behaviours and Expectations
|
### 3.1. Positive Behaviours and Expectations
|
||||||
|
|
||||||
Community Members are expected to demonstrate the following positive behaviours:
|
Community Members are expected to demonstrate the following positive behaviours:
|
||||||
|
|
||||||
#### 3.1.1 Respectful Communication
|
#### 3.1.1. Respectful Communication
|
||||||
- Use welcoming, inclusive, and professional language in all interactions
|
- Use welcoming, inclusive, and professional language in all interactions
|
||||||
- Listen actively and engage constructively with diverse perspectives and viewpoints
|
- Listen actively and engage constructively with diverse perspectives and viewpoints
|
||||||
- Provide constructive feedback that focuses on ideas and contributions rather than individuals
|
- Provide constructive feedback that focuses on ideas and contributions rather than individuals
|
||||||
- Acknowledge mistakes promptly, apologise sincerely when appropriate, and learn from errors
|
- Acknowledge mistakes promptly, apologise sincerely when appropriate, and learn from errors
|
||||||
|
|
||||||
#### 3.1.2 Collaborative Engagement
|
#### 3.1.2. Collaborative Engagement
|
||||||
- Contribute positively to discussions and community activities
|
- Contribute positively to discussions and community activities
|
||||||
- Support and mentor newcomers and less experienced community members
|
- Support and mentor newcomers and less experienced community members
|
||||||
- Share knowledge generously whilst respecting intellectual property rights
|
- Share knowledge generously whilst respecting intellectual property rights
|
||||||
- Participate in good faith and assume positive intent from others unless proven otherwise
|
- Participate in good faith and assume positive intent from others unless proven otherwise
|
||||||
|
|
||||||
#### 3.1.3 Professional Conduct
|
#### 3.1.3. Professional Conduct
|
||||||
- Maintain appropriate boundaries between personal and professional interactions
|
- Maintain appropriate boundaries between personal and professional interactions
|
||||||
- Respect the time, effort, and contributions of all community members
|
- Respect the time, effort, and contributions of all community members
|
||||||
- Comply with all applicable laws, regulations, and platform-specific terms of service
|
- Comply with all applicable laws, regulations, and platform-specific terms of service
|
||||||
- Represent Our Community positively when acting in any official or semi-official capacity
|
- Represent Our Community positively when acting in any official or semi-official capacity
|
||||||
|
|
||||||
### 3.2 Prohibited Conduct and Behaviours
|
### 3.2. Prohibited Conduct and Behaviours
|
||||||
|
|
||||||
**Reference to Comprehensive Usage Policies**: Detailed prohibited activities, content restrictions, and usage guidelines are comprehensively covered in our Acceptable Use Policy and Content and Moderation Policy, which are incorporated herein by reference.
|
**Reference to Comprehensive Usage Policies**: Detailed prohibited activities, content restrictions, and usage guidelines are comprehensively covered in our Acceptable Use Policy and Content and Moderation Policy, which are incorporated herein by reference.
|
||||||
|
|
||||||
#### 3.2.1 Community-Specific Prohibited Conduct
|
#### 3.2.1. Community-Specific Prohibited Conduct
|
||||||
|
|
||||||
In addition to all prohibitions in our comprehensive policies, the following behaviors are specifically prohibited in community interactions:
|
In addition to all prohibitions in our comprehensive policies, the following behaviours are specifically prohibited in community interactions:
|
||||||
|
|
||||||
**Identity and Discrimination:**
|
**Identity and Discrimination:**
|
||||||
- Deliberate misgendering, deadnaming, or use of rejected names or pronouns
|
- Deliberate misgendering, deadnaming, or use of rejected names or pronouns
|
||||||
@@ -169,54 +169,54 @@ In addition to all prohibitions in our comprehensive policies, the following beh
|
|||||||
|
|
||||||
## 4. Community Standards and Specific Policies
|
## 4. Community Standards and Specific Policies
|
||||||
|
|
||||||
### 4.1 Neutrality and Social Justice
|
### 4.1. Neutrality and Social Justice
|
||||||
|
|
||||||
#### 4.1.1 Position on Oppression
|
#### 4.1.1. Position on Oppression
|
||||||
|
|
||||||
:::caution[Community Position]
|
:::caution[Community Position]
|
||||||
Our Community explicitly rejects neutrality in the face of oppression. Remaining neutral when marginalised individuals share their experiences with discrimination, oppression, or harmful legislation constitutes support for oppressive systems and structures.
|
Our Community explicitly rejects neutrality in the face of oppression. Remaining neutral when marginalised individuals share their experiences with discrimination, oppression, or harmful legislation constitutes support for oppressive systems and structures.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
#### 4.1.2 Educational Approach
|
#### 4.1.2. Educational Approach
|
||||||
We recognise that not all community members may be fully aware of the challenges faced by marginalised communities. We encourage:
|
We recognise that not all community members may be fully aware of the challenges faced by marginalised communities. We encourage:
|
||||||
- Asking respectful questions to educate oneself about social justice issues
|
- Asking respectful questions to educate oneself about social justice issues
|
||||||
- Listening to the experiences of marginalised community members
|
- Listening to the experiences of marginalised community members
|
||||||
- Engaging constructively with discussions about equality and human rights
|
- Engaging constructively with discussions about equality and human rights
|
||||||
- Taking responsibility for one's own education on social justice matters
|
- Taking responsibility for one's own education on social justice matters
|
||||||
|
|
||||||
#### 4.1.3 Prohibited Responses
|
#### 4.1.3. Prohibited Responses
|
||||||
The following responses to discussions of oppression and marginalisation are considered violations of this Code:
|
The following responses to discussions of oppression and marginalisation are considered violations of this Code:
|
||||||
- Attempting to remain "neutral" or "bow out" of discussions about oppression
|
- Attempting to remain "neutral" or "bow out" of discussions about oppression
|
||||||
- Claiming that discussions of discrimination or social justice are inappropriate or divisive
|
- Claiming that discussions of discrimination or social justice are inappropriate or divisive
|
||||||
- Dismissing or minimising the experiences of marginalised community members
|
- Dismissing or minimising the experiences of marginalised community members
|
||||||
- Engaging in "whataboutism" or false equivalencies regarding discrimination
|
- Engaging in "whataboutism" or false equivalencies regarding discrimination
|
||||||
|
|
||||||
### 4.2 Intellectual Property and Privacy Rights
|
### 4.2. Intellectual Property and Privacy Rights
|
||||||
|
|
||||||
#### 4.2.1 Copyright and Attribution
|
#### 4.2.1. Copyright and Attribution
|
||||||
Community Members must:
|
Community Members must:
|
||||||
- Respect all copyright and intellectual property rights
|
- Respect all copyright and intellectual property rights
|
||||||
- Provide appropriate attribution when sharing or referencing others' work
|
- Provide appropriate attribution when sharing or referencing others' work
|
||||||
- Obtain permission before sharing copyrighted material
|
- Obtain permission before sharing copyrighted material
|
||||||
- Comply with fair use principles and applicable copyright laws
|
- Comply with fair use principles and applicable copyright laws
|
||||||
|
|
||||||
#### 4.2.2 Privacy Protection
|
#### 4.2.2. Privacy Protection
|
||||||
Community Members must:
|
Community Members must:
|
||||||
- Respect the privacy of all community members
|
- Respect the privacy of all community members
|
||||||
- Obtain explicit consent before sharing personal information about others
|
- Obtain explicit consent before sharing personal information about others
|
||||||
- Protect confidential information shared within community contexts
|
- Protect confidential information shared within community contexts
|
||||||
- Report privacy violations to Community Leaders promptly
|
- Report privacy violations to Community Leaders promptly
|
||||||
|
|
||||||
### 4.3 Content Standards and Community Guidelines
|
### 4.3. Content Standards and Community Guidelines
|
||||||
|
|
||||||
#### 4.3.1 Appropriate Content
|
#### 4.3.1. Appropriate Content
|
||||||
All content shared within Our Community must:
|
All content shared within Our Community must:
|
||||||
- Be relevant to community discussions and purposes
|
- Be relevant to community discussions and purposes
|
||||||
- Comply with platform-specific content policies
|
- Comply with platform-specific content policies
|
||||||
- Include appropriate content warnings when discussing potentially triggering topics
|
- Include appropriate content warnings when discussing potentially triggering topics
|
||||||
- Respect community standards regarding language, imagery, and subject matter
|
- Respect community standards regarding language, imagery, and subject matter
|
||||||
|
|
||||||
#### 4.3.2 Content Warnings and Accessibility
|
#### 4.3.2. Content Warnings and Accessibility
|
||||||
Community Members are required to:
|
Community Members are required to:
|
||||||
- Use content warnings when discussing potentially distressing topics
|
- Use content warnings when discussing potentially distressing topics
|
||||||
- Provide alternative text for images and visual content when possible
|
- Provide alternative text for images and visual content when possible
|
||||||
@@ -225,16 +225,16 @@ Community Members are required to:
|
|||||||
|
|
||||||
## 5. Reporting Procedures and Incident Response
|
## 5. Reporting Procedures and Incident Response
|
||||||
|
|
||||||
### 5.1 Reporting Mechanisms
|
### 5.1. Reporting Mechanisms
|
||||||
|
|
||||||
#### 5.1.1 Available Reporting Methods
|
#### 5.1.1. Available Reporting Methods
|
||||||
Community Members can report Code of Conduct violations through the following channels:
|
Community Members can report Code of Conduct violations through the following channels:
|
||||||
- **Discord Reporting**: Type `@Moderator` in any channel to alert Community Leaders
|
- **Discord Reporting**: Type `@Moderator` in any channel to alert Community Leaders
|
||||||
- **Direct Communication**: Contact any Community Leader through private messages
|
- **Direct Communication**: Contact any Community Leader through private messages
|
||||||
- **Email Contact**: Submit reports to contact@nhcarrigan.com
|
- **Email Contact**: Submit reports to contact@nhcarrigan.com
|
||||||
- **Anonymous Reporting**: Use designated anonymous reporting forms where available
|
- **Anonymous Reporting**: Use designated anonymous reporting forms where available
|
||||||
|
|
||||||
#### 5.1.2 Information to Include in Reports
|
#### 5.1.2. Information to Include in Reports
|
||||||
Effective reports should include:
|
Effective reports should include:
|
||||||
- Contact information (unless reporting anonymously)
|
- Contact information (unless reporting anonymously)
|
||||||
- Names, usernames, or identifiable information for all individuals involved
|
- Names, usernames, or identifiable information for all individuals involved
|
||||||
@@ -244,9 +244,9 @@ Effective reports should include:
|
|||||||
- Any previous related incidents or patterns of behaviour
|
- Any previous related incidents or patterns of behaviour
|
||||||
- Impact statement describing how the incident has affected you or others
|
- Impact statement describing how the incident has affected you or others
|
||||||
|
|
||||||
### 5.2 Report Handling and Investigation Procedures
|
### 5.2. Report Handling and Investigation Procedures
|
||||||
|
|
||||||
#### 5.2.1 Initial Response Protocol
|
#### 5.2.1. Initial Response Protocol
|
||||||
Upon receiving a report, Community Leaders will:
|
Upon receiving a report, Community Leaders will:
|
||||||
- Acknowledge receipt within 24 hours when possible
|
- Acknowledge receipt within 24 hours when possible
|
||||||
- Conduct an initial assessment of the report's severity and scope
|
- Conduct an initial assessment of the report's severity and scope
|
||||||
@@ -254,7 +254,7 @@ Upon receiving a report, Community Leaders will:
|
|||||||
- Recuse any Community Leaders who have conflicts of interest in the matter
|
- Recuse any Community Leaders who have conflicts of interest in the matter
|
||||||
- Begin formal investigation procedures within 72 hours
|
- Begin formal investigation procedures within 72 hours
|
||||||
|
|
||||||
#### 5.2.2 Investigation Standards
|
#### 5.2.2. Investigation Standards
|
||||||
All investigations will adhere to the following standards:
|
All investigations will adhere to the following standards:
|
||||||
- **Thoroughness**: Complete examination of all evidence and witness statements
|
- **Thoroughness**: Complete examination of all evidence and witness statements
|
||||||
- **Impartiality**: Fair consideration of all perspectives and evidence
|
- **Impartiality**: Fair consideration of all perspectives and evidence
|
||||||
@@ -262,7 +262,7 @@ All investigations will adhere to the following standards:
|
|||||||
- **Timeliness**: Completion of investigations in a reasonable timeframe
|
- **Timeliness**: Completion of investigations in a reasonable timeframe
|
||||||
- **Documentation**: Proper record-keeping for accountability and consistency
|
- **Documentation**: Proper record-keeping for accountability and consistency
|
||||||
|
|
||||||
#### 5.2.3 Confidentiality and Privacy Protection
|
#### 5.2.3. Confidentiality and Privacy Protection
|
||||||
Community Leaders commit to:
|
Community Leaders commit to:
|
||||||
- Respecting confidentiality requests from reporters and witnesses
|
- Respecting confidentiality requests from reporters and witnesses
|
||||||
- Limiting information sharing to those with legitimate need-to-know
|
- Limiting information sharing to those with legitimate need-to-know
|
||||||
@@ -270,16 +270,16 @@ Community Leaders commit to:
|
|||||||
- Balancing transparency with privacy protection
|
- Balancing transparency with privacy protection
|
||||||
- Never revealing harassment victims' identities without explicit, affirmative consent
|
- Never revealing harassment victims' identities without explicit, affirmative consent
|
||||||
|
|
||||||
### 5.3 Response and Resolution Options
|
### 5.3. Response and Resolution Options
|
||||||
|
|
||||||
#### 5.3.1 Protective Measures
|
#### 5.3.1. Protective Measures
|
||||||
Community Leaders may implement immediate protective measures including:
|
Community Leaders may implement immediate protective measures including:
|
||||||
- Temporary suspension of accused individuals pending investigation
|
- Temporary suspension of accused individuals pending investigation
|
||||||
- Modification of access permissions or privileges
|
- Modification of access permissions or privileges
|
||||||
- Implementation of no-contact orders between parties
|
- Implementation of no-contact orders between parties
|
||||||
- Enhanced monitoring of specific community areas or interactions
|
- Enhanced monitoring of specific community areas or interactions
|
||||||
|
|
||||||
#### 5.3.2 Public Statements and Warnings
|
#### 5.3.2. Public Statements and Warnings
|
||||||
At Community Leaders' discretion, we may:
|
At Community Leaders' discretion, we may:
|
||||||
- Issue public statements regarding individuals who pose community safety risks
|
- Issue public statements regarding individuals who pose community safety risks
|
||||||
- Provide private warnings to third parties when necessary for community protection
|
- Provide private warnings to third parties when necessary for community protection
|
||||||
@@ -288,25 +288,25 @@ At Community Leaders' discretion, we may:
|
|||||||
|
|
||||||
## 6. Disciplinary Framework and Enforcement
|
## 6. Disciplinary Framework and Enforcement
|
||||||
|
|
||||||
### 6.1 Reference to Comprehensive Enforcement Framework
|
### 6.1. Reference to Comprehensive Enforcement Framework
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive enforcement procedures, moderation standards, appeals processes, and disciplinary frameworks are set forth in our Content and Moderation Policy, which is incorporated herein by reference and governs all community enforcement matters.**
|
**IMPORTANT: Comprehensive enforcement procedures, moderation standards, appeals processes, and disciplinary frameworks are set forth in our Content and Moderation Policy, which is incorporated herein by reference and governs all community enforcement matters.**
|
||||||
|
|
||||||
### 6.2 Community-Specific Enforcement Principles
|
### 6.2. Community-Specific Enforcement Principles
|
||||||
|
|
||||||
In addition to the comprehensive framework in our Moderation Policy, community enforcement emphasizes:
|
In addition to the comprehensive framework in our Moderation Policy, community enforcement emphasises:
|
||||||
|
|
||||||
**(a)** **Restorative Justice**: Focus on repairing harm and restoring community relationships when possible;
|
**(a)** **Restorative Justice**: Focus on repairing harm and restoring community relationships when possible;
|
||||||
|
|
||||||
**(b)** **Community Safety**: Ultimate priority on protecting community members from harm and discrimination;
|
**(b)** **Community Safety**: Ultimate priority on protecting community members from harm and discrimination;
|
||||||
|
|
||||||
**(c)** **Educational Approach**: Emphasis on learning and behavior modification where appropriate;
|
**(c)** **Educational Approach**: Emphasis on learning and behaviour modification where appropriate;
|
||||||
|
|
||||||
**(d)** **Community Values**: Enforcement that upholds our specific community values of inclusivity and respect.
|
**(d)** **Community Values**: Enforcement that upholds our specific community values of inclusivity and respect.
|
||||||
|
|
||||||
### 6.2 Violation Assessment Criteria
|
### 6.2. Violation Assessment Criteria
|
||||||
|
|
||||||
#### 6.2.1 Sanctionable Conduct
|
#### 6.2.1. Sanctionable Conduct
|
||||||
Disciplinary sanctions may be imposed for:
|
Disciplinary sanctions may be imposed for:
|
||||||
- Direct violations of this Code of Conduct or associated community policies
|
- Direct violations of this Code of Conduct or associated community policies
|
||||||
- Behaviour that violates the spirit of community standards even if not explicitly prohibited
|
- Behaviour that violates the spirit of community standards even if not explicitly prohibited
|
||||||
@@ -314,7 +314,7 @@ Disciplinary sanctions may be imposed for:
|
|||||||
- Attempts to circumvent or evade existing sanctions
|
- Attempts to circumvent or evade existing sanctions
|
||||||
- Behaviour that demonstrates disregard for community values and member safety
|
- Behaviour that demonstrates disregard for community values and member safety
|
||||||
|
|
||||||
#### 6.2.2 Aggravating and Mitigating Factors
|
#### 6.2.2. Aggravating and Mitigating Factors
|
||||||
When determining appropriate sanctions, Community Leaders consider:
|
When determining appropriate sanctions, Community Leaders consider:
|
||||||
|
|
||||||
**Aggravating Factors:**
|
**Aggravating Factors:**
|
||||||
@@ -331,9 +331,9 @@ When determining appropriate sanctions, Community Leaders consider:
|
|||||||
- Acknowledgement of wrongdoing and commitment to improvement
|
- Acknowledgement of wrongdoing and commitment to improvement
|
||||||
- Circumstances that may have contributed to the violation
|
- Circumstances that may have contributed to the violation
|
||||||
|
|
||||||
### 6.3 Progressive Disciplinary System
|
### 6.3. Progressive Disciplinary System
|
||||||
|
|
||||||
#### 6.3.1 Level 1: Formal Reminder and Education
|
#### 6.3.1. Level 1: Formal Reminder and Education
|
||||||
**Typical Application:**
|
**Typical Application:**
|
||||||
- First-time violations of community standards
|
- First-time violations of community standards
|
||||||
- Use of inappropriate language or unprofessional behaviour
|
- Use of inappropriate language or unprofessional behaviour
|
||||||
@@ -352,7 +352,7 @@ When determining appropriate sanctions, Community Leaders consider:
|
|||||||
- Engaging in behaviour that disrupts community discussions
|
- Engaging in behaviour that disrupts community discussions
|
||||||
- Sharing content without appropriate warnings or context
|
- Sharing content without appropriate warnings or context
|
||||||
|
|
||||||
#### 6.3.2 Level 2: Formal Warning and Monitoring
|
#### 6.3.2. Level 2: Formal Warning and Monitoring
|
||||||
**Typical Application:**
|
**Typical Application:**
|
||||||
- Violations following previous reminders or educational interventions
|
- Violations following previous reminders or educational interventions
|
||||||
- Moderate violations of community standards
|
- Moderate violations of community standards
|
||||||
@@ -371,7 +371,7 @@ When determining appropriate sanctions, Community Leaders consider:
|
|||||||
- Repeated disruption of community discussions despite warnings
|
- Repeated disruption of community discussions despite warnings
|
||||||
- Failure to respect others' boundaries after being asked to stop
|
- Failure to respect others' boundaries after being asked to stop
|
||||||
|
|
||||||
#### 6.3.3 Level 3: Temporary Suspension and Mandatory Education
|
#### 6.3.3. Level 3: Temporary Suspension and Mandatory Education
|
||||||
**Typical Application:**
|
**Typical Application:**
|
||||||
- Serious violations of community standards
|
- Serious violations of community standards
|
||||||
- Repeated violations despite previous warnings
|
- Repeated violations despite previous warnings
|
||||||
@@ -390,7 +390,7 @@ When determining appropriate sanctions, Community Leaders consider:
|
|||||||
- Violations that significantly disrupt community activities or discussions
|
- Violations that significantly disrupt community activities or discussions
|
||||||
- Behaviour that makes other community members feel unsafe
|
- Behaviour that makes other community members feel unsafe
|
||||||
|
|
||||||
#### 6.3.4 Level 4: Permanent Exclusion
|
#### 6.3.4. Level 4: Permanent Exclusion
|
||||||
**Typical Application:**
|
**Typical Application:**
|
||||||
- Severe violations that pose significant risk to community safety
|
- Severe violations that pose significant risk to community safety
|
||||||
- Patterns of repeated violations with no demonstrated improvement
|
- Patterns of repeated violations with no demonstrated improvement
|
||||||
@@ -408,9 +408,9 @@ When determining appropriate sanctions, Community Leaders consider:
|
|||||||
- Sexual harassment or other forms of serious misconduct
|
- Sexual harassment or other forms of serious misconduct
|
||||||
- Attempts to harm the community or its members through any means
|
- Attempts to harm the community or its members through any means
|
||||||
|
|
||||||
### 6.4 Special Considerations and Additional Measures
|
### 6.4. Special Considerations and Additional Measures
|
||||||
|
|
||||||
#### 6.4.1 Enhanced Sanctions
|
#### 6.4.1. Enhanced Sanctions
|
||||||
Community Leaders may impose additional requirements or restrictions including:
|
Community Leaders may impose additional requirements or restrictions including:
|
||||||
- Public acknowledgement of wrongdoing and apology to affected parties
|
- Public acknowledgement of wrongdoing and apology to affected parties
|
||||||
- Completion of specific educational programmes or training
|
- Completion of specific educational programmes or training
|
||||||
@@ -418,7 +418,7 @@ Community Leaders may impose additional requirements or restrictions including:
|
|||||||
- Ongoing behavioural monitoring and reporting requirements
|
- Ongoing behavioural monitoring and reporting requirements
|
||||||
- Restrictions on specific community privileges or leadership opportunities
|
- Restrictions on specific community privileges or leadership opportunities
|
||||||
|
|
||||||
#### 6.4.2 Immediate Protection Measures
|
#### 6.4.2. Immediate Protection Measures
|
||||||
In cases where immediate action is necessary to protect community safety:
|
In cases where immediate action is necessary to protect community safety:
|
||||||
- Temporary suspension may be implemented immediately pending investigation
|
- Temporary suspension may be implemented immediately pending investigation
|
||||||
- Emergency removal from specific platforms or activities may occur
|
- Emergency removal from specific platforms or activities may occur
|
||||||
@@ -427,9 +427,9 @@ In cases where immediate action is necessary to protect community safety:
|
|||||||
|
|
||||||
## 7. Transparency and Accountability Systems
|
## 7. Transparency and Accountability Systems
|
||||||
|
|
||||||
### 7.1 Documentation and Record-Keeping
|
### 7.1. Documentation and Record-Keeping
|
||||||
|
|
||||||
#### 7.1.1 Comprehensive Logging System
|
#### 7.1.1. Comprehensive Logging System
|
||||||
All disciplinary actions are recorded in our public transparency system available at [https://hikari.nhcarrigan.com/sanctions](https://hikari.nhcarrigan.com/sanctions), including:
|
All disciplinary actions are recorded in our public transparency system available at [https://hikari.nhcarrigan.com/sanctions](https://hikari.nhcarrigan.com/sanctions), including:
|
||||||
- Date and time of each disciplinary action
|
- Date and time of each disciplinary action
|
||||||
- Type and severity of sanction imposed
|
- Type and severity of sanction imposed
|
||||||
@@ -439,39 +439,39 @@ All disciplinary actions are recorded in our public transparency system availabl
|
|||||||
- Community Leader responsible for implementing the sanction
|
- Community Leader responsible for implementing the sanction
|
||||||
- Relevant evidence or documentation (with appropriate redaction)
|
- Relevant evidence or documentation (with appropriate redaction)
|
||||||
|
|
||||||
#### 7.1.2 Privacy Protection in Documentation
|
#### 7.1.2. Privacy Protection in Documentation
|
||||||
While maintaining transparency, we protect individual privacy by:
|
While maintaining transparency, we protect individual privacy by:
|
||||||
- Anonymising personally identifiable information in public logs
|
- Anonymising personally identifiable information in public logs
|
||||||
- Redacting sensitive details that could enable identification of victims
|
- Redacting sensitive details that could enable identification of victims
|
||||||
- Balancing transparency with confidentiality requirements
|
- Balancing transparency with confidentiality requirements
|
||||||
- Providing more detailed information only to authorised personnel
|
- Providing more detailed information only to authorised personnel
|
||||||
|
|
||||||
### 7.2 Appeals and Review Process
|
### 7.2. Appeals and Review Process
|
||||||
|
|
||||||
#### 7.2.1 Right to Appeal
|
#### 7.2.1. Right to Appeal
|
||||||
Individuals subject to disciplinary sanctions have the right to appeal such decisions through our [formal appeals process](/community/appeal), which includes:
|
Individuals subject to disciplinary sanctions have the right to appeal such decisions through our [formal appeals process](/community/appeal), which includes:
|
||||||
- Review by Community Leaders not involved in the original decision
|
- Review by Community Leaders not involved in the original decision
|
||||||
- Consideration of new evidence or mitigating circumstances
|
- Consideration of new evidence or mitigating circumstances
|
||||||
- Opportunity to present alternative perspectives or explanations
|
- Opportunity to present alternative perspectives or explanations
|
||||||
- Fair and impartial review of the original decision and its basis
|
- Fair and impartial review of the original decision and its basis
|
||||||
|
|
||||||
#### 7.2.2 Appeals Process Integrity
|
#### 7.2.2. Appeals Process Integrity
|
||||||
During the appeals process:
|
During the appeals process:
|
||||||
- Original sanctions remain in effect pending review
|
- Original sanctions remain in effect pending review
|
||||||
- Appeals are reviewed by impartial Community Leaders
|
- Appeals are reviewed by impartial Community Leaders
|
||||||
- Decisions are based on evidence and established community standards
|
- Decisions are based on evidence and established community standards
|
||||||
- Final appeal decisions are communicated with detailed reasoning
|
- Final appeal decisions are communicated with detailed reasoning
|
||||||
|
|
||||||
### 7.3 Community Oversight and Continuous Improvement
|
### 7.3. Community Oversight and Continuous Improvement
|
||||||
|
|
||||||
#### 7.3.1 Regular Review and Assessment
|
#### 7.3.1. Regular Review and Assessment
|
||||||
Our disciplinary system undergoes regular review including:
|
Our disciplinary system undergoes regular review including:
|
||||||
- Annual assessment of consistency in sanction application
|
- Annual assessment of consistency in sanction application
|
||||||
- Community feedback collection on disciplinary processes
|
- Community feedback collection on disciplinary processes
|
||||||
- Review of appeals outcomes to identify systemic issues
|
- Review of appeals outcomes to identify systemic issues
|
||||||
- Updates to policies and procedures based on community evolution
|
- Updates to policies and procedures based on community evolution
|
||||||
|
|
||||||
#### 7.3.2 Community Leader Accountability
|
#### 7.3.2. Community Leader Accountability
|
||||||
Community Leaders are held accountable through:
|
Community Leaders are held accountable through:
|
||||||
- Regular training on community standards and disciplinary procedures
|
- Regular training on community standards and disciplinary procedures
|
||||||
- Peer review of disciplinary decisions for consistency
|
- Peer review of disciplinary decisions for consistency
|
||||||
@@ -480,9 +480,9 @@ Community Leaders are held accountable through:
|
|||||||
|
|
||||||
## 8. Advertising, Promotion, and Commercial Activity
|
## 8. Advertising, Promotion, and Commercial Activity
|
||||||
|
|
||||||
### 8.1 General Prohibition on Commercial Activity
|
### 8.1. General Prohibition on Commercial Activity
|
||||||
|
|
||||||
#### 8.1.1 Scope of Prohibition
|
#### 8.1.1. Scope of Prohibition
|
||||||
Commercial advertising and self-promotion are generally prohibited within Our Community spaces, including:
|
Commercial advertising and self-promotion are generally prohibited within Our Community spaces, including:
|
||||||
- Unsolicited promotion of products, services, websites, or social media accounts
|
- Unsolicited promotion of products, services, websites, or social media accounts
|
||||||
- Commercial advertising or marketing communications
|
- Commercial advertising or marketing communications
|
||||||
@@ -490,38 +490,38 @@ Commercial advertising and self-promotion are generally prohibited within Our Co
|
|||||||
- Affiliate marketing or referral link sharing
|
- Affiliate marketing or referral link sharing
|
||||||
- Solicitation for commercial purposes or business development
|
- Solicitation for commercial purposes or business development
|
||||||
|
|
||||||
#### 8.1.2 Rationale for Restrictions
|
#### 8.1.2. Rationale for Restrictions
|
||||||
These restrictions exist to:
|
These restrictions exist to:
|
||||||
- Maintain focus on community purposes and objectives
|
- Maintain focus on community purposes and objectives
|
||||||
- Prevent exploitation of community relationships for commercial gain
|
- Prevent exploitation of community relationships for commercial gain
|
||||||
- Ensure equal participation opportunities for all members
|
- Ensure equal participation opportunities for all members
|
||||||
- Protect community members from unwanted commercial solicitation
|
- Protect community members from unwanted commercial solicitation
|
||||||
|
|
||||||
### 8.2 Authorised Exceptions and Permitted Activities
|
### 8.2. Authorised Exceptions and Permitted Activities
|
||||||
|
|
||||||
#### 8.2.1 Approved Commercial Activities
|
#### 8.2.1. Approved Commercial Activities
|
||||||
The following activities are permitted when explicitly authorised:
|
The following activities are permitted when explicitly authorised:
|
||||||
- Official announcements or promotions approved by Community Leaders
|
- Official announcements or promotions approved by Community Leaders
|
||||||
- Sharing of resources directly relevant to ongoing discussions when done in good faith
|
- Sharing of resources directly relevant to ongoing discussions when done in good faith
|
||||||
- Links or information specifically requested by Community Leaders for support or moderation purposes
|
- Links or information specifically requested by Community Leaders for support or moderation purposes
|
||||||
- Educational resources that provide value to the community without primary commercial purpose
|
- Educational resources that provide value to the community without primary commercial purpose
|
||||||
|
|
||||||
#### 8.2.2 Context-Appropriate Sharing
|
#### 8.2.2. Context-Appropriate Sharing
|
||||||
Limited sharing may be acceptable when:
|
Limited sharing may be acceptable when:
|
||||||
- Content is directly relevant to current discussions or community needs
|
- Content is directly relevant to current discussions or community needs
|
||||||
- Sharing is done transparently without hidden commercial motives
|
- Sharing is done transparently without hidden commercial motives
|
||||||
- The primary purpose is education or community benefit rather than promotion
|
- The primary purpose is education or community benefit rather than promotion
|
||||||
- Appropriate disclosure of any commercial relationships or affiliations is provided
|
- Appropriate disclosure of any commercial relationships or affiliations is provided
|
||||||
|
|
||||||
### 8.3 Compliance and Enforcement
|
### 8.3. Compliance and Enforcement
|
||||||
|
|
||||||
#### 8.3.1 Disclosure Requirements
|
#### 8.3.1. Disclosure Requirements
|
||||||
When sharing any content with potential commercial implications, Community Members must:
|
When sharing any content with potential commercial implications, Community Members must:
|
||||||
- Clearly disclose any personal, professional, or financial relationships with promoted entities
|
- Clearly disclose any personal, professional, or financial relationships with promoted entities
|
||||||
- Identify themselves when sharing content from projects or organisations with which they are affiliated
|
- Identify themselves when sharing content from projects or organisations with which they are affiliated
|
||||||
- Be transparent about any potential benefits they may receive from community members' engagement
|
- Be transparent about any potential benefits they may receive from community members' engagement
|
||||||
|
|
||||||
#### 8.3.2 Violation Consequences
|
#### 8.3.2. Violation Consequences
|
||||||
Violations of advertising and promotion restrictions will be addressed through:
|
Violations of advertising and promotion restrictions will be addressed through:
|
||||||
- Content removal and community member education for minor violations
|
- Content removal and community member education for minor violations
|
||||||
- Formal warnings for repeated or more serious promotional activities
|
- Formal warnings for repeated or more serious promotional activities
|
||||||
@@ -530,16 +530,16 @@ Violations of advertising and promotion restrictions will be addressed through:
|
|||||||
|
|
||||||
## 9. Language Requirements and Communication Standards
|
## 9. Language Requirements and Communication Standards
|
||||||
|
|
||||||
### 9.1 Official Language Policy
|
### 9.1. Official Language Policy
|
||||||
|
|
||||||
#### 9.1.1 English as Primary Language
|
#### 9.1.1. English as Primary Language
|
||||||
The official language of Our Community is English, and all community interactions, discussions, and contributions should be conducted in English to ensure:
|
The official language of Our Community is English, and all community interactions, discussions, and contributions should be conducted in English to ensure:
|
||||||
- Clear communication among all community members
|
- Clear communication among all community members
|
||||||
- Effective moderation and community management
|
- Effective moderation and community management
|
||||||
- Consistency across all community platforms and activities
|
- Consistency across all community platforms and activities
|
||||||
- Accessibility for the broadest range of community members
|
- Accessibility for the broadest range of community members
|
||||||
|
|
||||||
#### 9.1.2 Scope of Application
|
#### 9.1.2. Scope of Application
|
||||||
The English language requirement applies to:
|
The English language requirement applies to:
|
||||||
- All public discussions and communications within community spaces
|
- All public discussions and communications within community spaces
|
||||||
- Documentation, contributions, and community-generated content
|
- Documentation, contributions, and community-generated content
|
||||||
@@ -547,32 +547,32 @@ The English language requirement applies to:
|
|||||||
- Support requests and community assistance interactions
|
- Support requests and community assistance interactions
|
||||||
- Disciplinary and administrative communications
|
- Disciplinary and administrative communications
|
||||||
|
|
||||||
### 9.2 Support for Non-Native English Speakers
|
### 9.2. Support for Non-Native English Speakers
|
||||||
|
|
||||||
#### 9.2.1 Inclusive Approach
|
#### 9.2.1. Inclusive Approach
|
||||||
We actively support non-native English speakers by:
|
We actively support non-native English speakers by:
|
||||||
- Encouraging patience and understanding from all community members
|
- Encouraging patience and understanding from all community members
|
||||||
- Providing assistance with language barriers when appropriate
|
- Providing assistance with language barriers when appropriate
|
||||||
- Focusing on the substance of contributions rather than perfect grammar or syntax
|
- Focusing on the substance of contributions rather than perfect grammar or syntax
|
||||||
- Offering clarification and rephrasing when communication difficulties arise
|
- Offering clarification and rephrasing when communication difficulties arise
|
||||||
|
|
||||||
#### 9.2.2 Accommodation Measures
|
#### 9.2.2. Accommodation Measures
|
||||||
Community Members are encouraged to:
|
Community Members are encouraged to:
|
||||||
- Help clarify or rephrase messages when language barriers exist
|
- Help clarify or rephrase messages when language barriers exist
|
||||||
- Provide gentle correction or assistance when requested
|
- Provide gentle correction or assistance when requested
|
||||||
- Use clear, simple language to facilitate understanding
|
- Use clear, simple language to facilitate understanding
|
||||||
- Be patient with translation delays or communication difficulties
|
- Be patient with translation delays or communication difficulties
|
||||||
|
|
||||||
### 9.3 Limited Exceptions and Special Circumstances
|
### 9.3. Limited Exceptions and Special Circumstances
|
||||||
|
|
||||||
#### 9.3.1 Permitted Exceptions
|
#### 9.3.1. Permitted Exceptions
|
||||||
Limited use of languages other than English may be acceptable for:
|
Limited use of languages other than English may be acceptable for:
|
||||||
- Brief translations provided to assist community members, when immediately accompanied by English translation
|
- Brief translations provided to assist community members, when immediately accompanied by English translation
|
||||||
- Cultural sharing or educational content when clearly contextualised and explained in English
|
- Cultural sharing or educational content when clearly contextualised and explained in English
|
||||||
- Emergency situations where immediate communication is necessary
|
- Emergency situations where immediate communication is necessary
|
||||||
- Specific community events or activities explicitly designated as multilingual
|
- Specific community events or activities explicitly designated as multilingual
|
||||||
|
|
||||||
#### 9.3.2 Translation and Accessibility Tools
|
#### 9.3.2. Translation and Accessibility Tools
|
||||||
Community Members may:
|
Community Members may:
|
||||||
- Use translation tools to assist with participation, provided English content is also included
|
- Use translation tools to assist with participation, provided English content is also included
|
||||||
- Request assistance with translation when needed for full participation
|
- Request assistance with translation when needed for full participation
|
||||||
@@ -580,56 +580,56 @@ Community Members may:
|
|||||||
|
|
||||||
## 10. Implementation, Amendment, and Enforcement
|
## 10. Implementation, Amendment, and Enforcement
|
||||||
|
|
||||||
### 10.1 Code Implementation and Effective Date
|
### 10.1. Code Implementation
|
||||||
|
|
||||||
#### 10.1.1 Immediate Effect
|
#### 10.1.1. Immediate Effect
|
||||||
This Code of Conduct takes effect immediately upon publication and applies to all community interactions occurring after its implementation. Community Members are responsible for familiarising themselves with these standards and ensuring compliance in all community activities.
|
This Code of Conduct takes effect immediately upon publication and applies to all community interactions occurring after its implementation. Community Members are responsible for familiarising themselves with these standards and ensuring compliance in all community activities.
|
||||||
|
|
||||||
#### 10.1.2 Retroactive Considerations
|
#### 10.1.2. Retroactive Considerations
|
||||||
While this Code primarily governs future conduct, Community Leaders reserve the right to consider past behaviour patterns when assessing current community participation and determining appropriate responses to new violations.
|
While this Code primarily governs future conduct, Community Leaders reserve the right to consider past behaviour patterns when assessing current community participation and determining appropriate responses to new violations.
|
||||||
|
|
||||||
### 10.2 Amendment and Update Procedures
|
### 10.2. Amendment and Update Procedures
|
||||||
|
|
||||||
#### 10.2.1 Amendment Authority
|
#### 10.2.1. Amendment Authority
|
||||||
This Code may be amended, updated, or modified at any time by Community Leaders to:
|
This Code may be amended, updated, or modified at any time by Community Leaders to:
|
||||||
- Address emerging community issues or challenges
|
- Address emerging community issues or challenges
|
||||||
- Incorporate lessons learned from community experiences
|
- Incorporate lessons learned from community experiences
|
||||||
- Reflect changes in legal requirements or best practices
|
- Reflect changes in legal requirements or best practices
|
||||||
- Respond to community feedback and suggestions for improvement
|
- Respond to community feedback and suggestions for improvement
|
||||||
|
|
||||||
#### 10.2.2 Change Communication
|
#### 10.2.2. Change Communication
|
||||||
Significant amendments to this Code will be communicated to the community through:
|
Significant amendments to this Code will be communicated to the community through:
|
||||||
- Announcements in primary community channels
|
- Announcements in primary community channels
|
||||||
- Updates to community documentation and resources
|
- Updates to community documentation and resources
|
||||||
- Direct notification to Community Leaders and active participants
|
- Direct notification to Community Leaders and active participants
|
||||||
- Clear indication of changes in publicly accessible versions
|
- Clear indication of changes in publicly accessible versions
|
||||||
|
|
||||||
### 10.3 Enforcement Authority and Discretion
|
### 10.3. Enforcement Authority and Discretion
|
||||||
|
|
||||||
#### 10.3.1 Community Leader Authority
|
#### 10.3.1. Community Leader Authority
|
||||||
Community Leaders possess both the authority and obligation to:
|
Community Leaders possess both the authority and obligation to:
|
||||||
- Interpret and apply this Code consistently and fairly
|
- Interpret and apply this Code consistently and fairly
|
||||||
- Take any action deemed necessary to protect community safety and integrity
|
- Take any action deemed necessary to protect community safety and integrity
|
||||||
- Modify or expand enforcement procedures as community needs evolve
|
- Modify or expand enforcement procedures as community needs evolve
|
||||||
- Collaborate with external authorities when violations involve illegal activity
|
- Collaborate with external authorities when violations involve illegal activity
|
||||||
|
|
||||||
#### 10.3.2 Discretionary Enforcement
|
#### 10.3.2. Discretionary Enforcement
|
||||||
While this Code provides comprehensive guidance, Community Leaders retain discretion to:
|
While this Code provides comprehensive guidance, Community Leaders retain discretion to:
|
||||||
- Address situations not explicitly covered by written policies
|
- Address situations not explicitly covered by written policies
|
||||||
- Apply contextual judgement in complex or unusual circumstances
|
- Apply contextual judgement in complex or unusual circumstances
|
||||||
- Implement innovative solutions to emerging community challenges
|
- Implement innovative solutions to emerging community challenges
|
||||||
- Prioritise community safety and well-being over rigid rule application
|
- Prioritise community safety and well-being over rigid rule application
|
||||||
|
|
||||||
### 10.4 Legal and Operational Integration
|
### 10.4. Legal and Operational Integration
|
||||||
|
|
||||||
#### 10.4.1 Relationship to Other Policies
|
#### 10.4.1. Relationship to Other Policies
|
||||||
This Code operates in conjunction with and supplements:
|
This Code operates in conjunction with and supplements:
|
||||||
- Terms of Service and User Agreements
|
- Terms of Service and User Agreements
|
||||||
- Privacy Policies and Data Protection Measures
|
- Privacy Policies and Data Protection Measures
|
||||||
- Platform-specific Terms of Use and Community Guidelines
|
- Platform-specific Terms of Use and Community Guidelines
|
||||||
- Applicable laws and regulations governing online communities
|
- Applicable laws and regulations governing online communities
|
||||||
|
|
||||||
#### 10.4.2 Conflict Resolution
|
#### 10.4.2. Conflict Resolution
|
||||||
In the event of conflicts between this Code and other policies:
|
In the event of conflicts between this Code and other policies:
|
||||||
- The provision that provides greater protection for community members shall take precedence
|
- The provision that provides greater protection for community members shall take precedence
|
||||||
- Community Leaders will interpret policies to maximise safety and inclusivity
|
- Community Leaders will interpret policies to maximise safety and inclusivity
|
||||||
@@ -651,4 +651,4 @@ This Code represents our collective commitment to building and maintaining a com
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Community Code of Conduct was last updated on 15 September 2025 and supersedes all previous versions. For questions regarding this Code or to report violations, please contact our Community Leaders through the designated reporting channels outlined above.*
|
*This Community Code of Conduct. For questions regarding this Code or to report violations, please contact our Community Leaders through the designated reporting channels outlined above.*
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ title: Community Feedback and Participation Policy
|
|||||||
|
|
||||||
## 1. Foundation and Democratic Principles
|
## 1. Foundation and Democratic Principles
|
||||||
|
|
||||||
### 1.1 Introduction and Purpose
|
### 1.1. Introduction and Purpose
|
||||||
|
|
||||||
This Community Feedback and Participation Policy (hereinafter referred to as "the Policy") establishes our comprehensive framework for meaningful community member engagement in governance, policy development, and community improvement processes. This Policy embodies our commitment to participatory governance, ensuring that community members have multiple accessible pathways to influence decisions that affect their community experience and contribute to the continuous improvement of our shared environment.
|
This Community Feedback and Participation Policy (hereinafter referred to as "the Policy") establishes our comprehensive framework for meaningful community member engagement in governance, policy development, and community improvement processes. This Policy embodies our commitment to participatory governance, ensuring that community members have multiple accessible pathways to influence decisions that affect their community experience and contribute to the continuous improvement of our shared environment.
|
||||||
|
|
||||||
### 1.2 Core Democratic Principles
|
### 1.2. Core Democratic Principles
|
||||||
|
|
||||||
Our community feedback and participation approach is founded upon:
|
Our community feedback and participation approach is founded upon:
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ Our community feedback and participation approach is founded upon:
|
|||||||
|
|
||||||
**(f)** **Democratic Accountability**: Mechanisms ensuring leadership remains accountable to the community they serve.
|
**(f)** **Democratic Accountability**: Mechanisms ensuring leadership remains accountable to the community they serve.
|
||||||
|
|
||||||
### 1.3 Participation Philosophy
|
### 1.3. Participation Philosophy
|
||||||
|
|
||||||
We believe that community members are the ultimate experts on their own experience and needs, and our governance systems should reflect this expertise by:
|
We believe that community members are the ultimate experts on their own experience and needs, and our governance systems should reflect this expertise by:
|
||||||
- Actively seeking diverse community perspectives on policies and decisions
|
- Actively seeking diverse community perspectives on policies and decisions
|
||||||
@@ -33,15 +33,15 @@ We believe that community members are the ultimate experts on their own experien
|
|||||||
- Building community ownership and investment in shared governance and improvement processes
|
- Building community ownership and investment in shared governance and improvement processes
|
||||||
- Fostering a culture of collaborative decision-making and mutual responsibility
|
- Fostering a culture of collaborative decision-making and mutual responsibility
|
||||||
|
|
||||||
### 1.4 Legal Framework Integration
|
### 1.4. Legal Framework Integration
|
||||||
|
|
||||||
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Privacy Policy, Community Code of Conduct, and Community Leadership and Governance Policy, all of which are incorporated herein by reference.
|
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Privacy Policy, Community Code of Conduct, and Community Leadership and Governance Policy, all of which are incorporated herein by reference.
|
||||||
|
|
||||||
## 2. Feedback Channels and Communication Systems
|
## 2. Feedback Channels and Communication Systems
|
||||||
|
|
||||||
### 2.1 Regular Feedback Opportunities
|
### 2.1. Regular Feedback Opportunities
|
||||||
|
|
||||||
#### 2.1.1 Daily and Ongoing Feedback Channels
|
#### 2.1.1. Daily and Ongoing Feedback Channels
|
||||||
|
|
||||||
**Open Communication Channels:**
|
**Open Communication Channels:**
|
||||||
- Dedicated feedback channels accessible to all community members for ongoing input and suggestions
|
- Dedicated feedback channels accessible to all community members for ongoing input and suggestions
|
||||||
@@ -60,7 +60,7 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- Accessibility feedback channels specifically designed to identify and address inclusion barriers
|
- Accessibility feedback channels specifically designed to identify and address inclusion barriers
|
||||||
- `#accessibility` on Discord.
|
- `#accessibility` on Discord.
|
||||||
|
|
||||||
#### 2.1.2 Scheduled Feedback Collection
|
#### 2.1.2. Scheduled Feedback Collection
|
||||||
|
|
||||||
**Monthly Community Input Sessions:**
|
**Monthly Community Input Sessions:**
|
||||||
- Structured community meetings focused on specific policy areas or community improvements
|
- Structured community meetings focused on specific policy areas or community improvements
|
||||||
@@ -74,9 +74,9 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- Community needs assessments identifying emerging priorities and improvement opportunities
|
- Community needs assessments identifying emerging priorities and improvement opportunities
|
||||||
- Leadership performance evaluations providing community input on governance effectiveness
|
- Leadership performance evaluations providing community input on governance effectiveness
|
||||||
|
|
||||||
### 2.2 Accessible Participation Methods
|
### 2.2. Accessible Participation Methods
|
||||||
|
|
||||||
#### 2.2.1 Universal Design in Feedback Systems
|
#### 2.2.1. Universal Design in Feedback Systems
|
||||||
|
|
||||||
**Multiple Communication Formats:**
|
**Multiple Communication Formats:**
|
||||||
- Written feedback forms available in multiple languages and accessible formats
|
- Written feedback forms available in multiple languages and accessible formats
|
||||||
@@ -90,7 +90,7 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- Simple language versions of feedback requests and policy summaries for improved comprehension
|
- Simple language versions of feedback requests and policy summaries for improved comprehension
|
||||||
- Alternative format materials and documentation available upon request
|
- Alternative format materials and documentation available upon request
|
||||||
|
|
||||||
#### 2.2.2 Cultural and Linguistic Inclusion
|
#### 2.2.2. Cultural and Linguistic Inclusion
|
||||||
|
|
||||||
**Culturally Responsive Feedback Collection:**
|
**Culturally Responsive Feedback Collection:**
|
||||||
- Feedback systems designed with cultural sensitivity and diverse communication style accommodation
|
- Feedback systems designed with cultural sensitivity and diverse communication style accommodation
|
||||||
@@ -106,9 +106,9 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
|
|
||||||
## 3. Policy Development and Change Processes
|
## 3. Policy Development and Change Processes
|
||||||
|
|
||||||
### 3.1 Community Consultation Requirements
|
### 3.1. Community Consultation Requirements
|
||||||
|
|
||||||
#### 3.1.1 Mandatory Consultation Procedures
|
#### 3.1.1. Mandatory Consultation Procedures
|
||||||
|
|
||||||
**Significant Policy Changes:**
|
**Significant Policy Changes:**
|
||||||
All significant policy changes must include:
|
All significant policy changes must include:
|
||||||
@@ -123,7 +123,7 @@ All significant policy changes must include:
|
|||||||
- **Stakeholder consultation** ensuring input from community members who would be most affected by new policies
|
- **Stakeholder consultation** ensuring input from community members who would be most affected by new policies
|
||||||
- **Implementation planning** involving community input on effective policy rollout and communication strategies
|
- **Implementation planning** involving community input on effective policy rollout and communication strategies
|
||||||
|
|
||||||
#### 3.1.2 Community Input Integration Process
|
#### 3.1.2. Community Input Integration Process
|
||||||
|
|
||||||
**Systematic Input Analysis:**
|
**Systematic Input Analysis:**
|
||||||
- **Comprehensive review** of all community feedback and input received during consultation periods
|
- **Comprehensive review** of all community feedback and input received during consultation periods
|
||||||
@@ -137,9 +137,9 @@ All significant policy changes must include:
|
|||||||
- **Implementation timelines** and community preparation information for policy changes
|
- **Implementation timelines** and community preparation information for policy changes
|
||||||
- **Ongoing evaluation commitments** outlining how policy effectiveness will be assessed with community input
|
- **Ongoing evaluation commitments** outlining how policy effectiveness will be assessed with community input
|
||||||
|
|
||||||
### 3.2 Emergency and Urgent Change Procedures
|
### 3.2. Emergency and Urgent Change Procedures
|
||||||
|
|
||||||
#### 3.2.1 Emergency Policy Modifications
|
#### 3.2.1. Emergency Policy Modifications
|
||||||
|
|
||||||
**Crisis Response Policy Changes:**
|
**Crisis Response Policy Changes:**
|
||||||
When immediate policy changes are necessary for community safety:
|
When immediate policy changes are necessary for community safety:
|
||||||
@@ -148,7 +148,7 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Community input integration** for permanent policy changes following emergency measures
|
- **Community input integration** for permanent policy changes following emergency measures
|
||||||
- **Transparent review process** evaluating emergency decisions and incorporating community feedback for future improvements
|
- **Transparent review process** evaluating emergency decisions and incorporating community feedback for future improvements
|
||||||
|
|
||||||
#### 3.2.2 Urgent Community Need Response
|
#### 3.2.2. Urgent Community Need Response
|
||||||
|
|
||||||
**Expedited Change Procedures:**
|
**Expedited Change Procedures:**
|
||||||
- **Accelerated consultation timelines** with intensive community outreach and input collection
|
- **Accelerated consultation timelines** with intensive community outreach and input collection
|
||||||
@@ -158,9 +158,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
|
|
||||||
## 4. Transparency and Decision-Making Communication
|
## 4. Transparency and Decision-Making Communication
|
||||||
|
|
||||||
### 4.1 Open Governance Practices
|
### 4.1. Open Governance Practices
|
||||||
|
|
||||||
#### 4.1.1 Decision-Making Transparency
|
#### 4.1.1. Decision-Making Transparency
|
||||||
|
|
||||||
**Public Decision Records:**
|
**Public Decision Records:**
|
||||||
- **Meeting minutes and records** available to all community members for transparency and accountability
|
- **Meeting minutes and records** available to all community members for transparency and accountability
|
||||||
@@ -172,9 +172,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Regular office hours** where community members can directly engage with leadership about governance and policy matters
|
- **Regular office hours** where community members can directly engage with leadership about governance and policy matters
|
||||||
- **Public Q&A sessions** addressing community concerns and providing transparent answers about decision-making processes
|
- **Public Q&A sessions** addressing community concerns and providing transparent answers about decision-making processes
|
||||||
- **Leadership communication channels** accessible to all community members for ongoing dialogue and feedback
|
- **Leadership communication channels** accessible to all community members for ongoing dialogue and feedback
|
||||||
- **Community liaison programs** facilitating communication between leadership and diverse community groups
|
- **Community liaison programmes** facilitating communication between leadership and diverse community groups
|
||||||
|
|
||||||
#### 4.1.2 Information Accessibility and Sharing
|
#### 4.1.2. Information Accessibility and Sharing
|
||||||
|
|
||||||
**Comprehensive Information Access:**
|
**Comprehensive Information Access:**
|
||||||
- **Policy documentation** available in multiple formats and accessible language for broad community understanding
|
- **Policy documentation** available in multiple formats and accessible language for broad community understanding
|
||||||
@@ -188,9 +188,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Multiple communication channels** ensuring information reaches community members through their preferred methods
|
- **Multiple communication channels** ensuring information reaches community members through their preferred methods
|
||||||
- **Follow-up communication** about decision outcomes and implementation progress
|
- **Follow-up communication** about decision outcomes and implementation progress
|
||||||
|
|
||||||
### 4.2 Community Accountability Mechanisms
|
### 4.2. Community Accountability Mechanisms
|
||||||
|
|
||||||
#### 4.2.1 Leadership Accountability Systems
|
#### 4.2.1. Leadership Accountability Systems
|
||||||
|
|
||||||
**Performance Monitoring and Evaluation:**
|
**Performance Monitoring and Evaluation:**
|
||||||
- **Regular community confidence surveys** assessing leadership effectiveness and community satisfaction
|
- **Regular community confidence surveys** assessing leadership effectiveness and community satisfaction
|
||||||
@@ -204,7 +204,7 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Community follow-up** ensuring leadership commitments are fulfilled and community concerns are adequately addressed
|
- **Community follow-up** ensuring leadership commitments are fulfilled and community concerns are adequately addressed
|
||||||
- **Continuous improvement integration** incorporating accountability feedback into leadership development and governance enhancement
|
- **Continuous improvement integration** incorporating accountability feedback into leadership development and governance enhancement
|
||||||
|
|
||||||
#### 4.2.2 Policy Effectiveness Assessment
|
#### 4.2.2. Policy Effectiveness Assessment
|
||||||
|
|
||||||
**Community-Centred Evaluation:**
|
**Community-Centred Evaluation:**
|
||||||
- **Regular policy effectiveness surveys** gathering community input on how well policies are meeting their intended objectives
|
- **Regular policy effectiveness surveys** gathering community input on how well policies are meeting their intended objectives
|
||||||
@@ -214,13 +214,13 @@ When immediate policy changes are necessary for community safety:
|
|||||||
|
|
||||||
## 5. Special Consultation and Participation Programs
|
## 5. Special Consultation and Participation Programs
|
||||||
|
|
||||||
### 5.1 Demographic and Identity-Based Consultation
|
### 5.1. Demographic and Identity-Based Consultation
|
||||||
|
|
||||||
#### 5.1.1 Targeted Community Outreach
|
#### 5.1.1. Targeted Community Outreach
|
||||||
|
|
||||||
**Underrepresented Group Engagement:**
|
**Underrepresented Group Engagement:**
|
||||||
- **Specific consultation programs** ensuring input from community members who may not participate in general feedback processes
|
- **Specific consultation programmes** ensuring input from community members who may not participate in general feedback processes
|
||||||
- **Identity-affirming participation opportunities** creating safe spaces for marginalized community members to provide honest feedback
|
- **Identity-affirming participation opportunities** creating safe spaces for marginalised community members to provide honest feedback
|
||||||
- **Cultural competency** in consultation design and facilitation to encourage authentic participation from diverse community members
|
- **Cultural competency** in consultation design and facilitation to encourage authentic participation from diverse community members
|
||||||
- **Language and accessibility support** removing barriers to participation for community members with diverse needs
|
- **Language and accessibility support** removing barriers to participation for community members with diverse needs
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Accessibility advisory groups** providing ongoing input on inclusion and accommodation needs and improvements
|
- **Accessibility advisory groups** providing ongoing input on inclusion and accommodation needs and improvements
|
||||||
- **Community youth and senior advisory panels** ensuring intergenerational perspectives in community governance
|
- **Community youth and senior advisory panels** ensuring intergenerational perspectives in community governance
|
||||||
|
|
||||||
#### 5.1.2 Community-Driven Initiative Support
|
#### 5.1.2. Community-Driven Initiative Support
|
||||||
|
|
||||||
**Grassroots Proposal Development:**
|
**Grassroots Proposal Development:**
|
||||||
- **Community member proposal processes** enabling members to suggest and develop new community initiatives and improvements
|
- **Community member proposal processes** enabling members to suggest and develop new community initiatives and improvements
|
||||||
@@ -239,22 +239,22 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Implementation support** for community-approved initiatives including resource allocation and ongoing assistance
|
- **Implementation support** for community-approved initiatives including resource allocation and ongoing assistance
|
||||||
|
|
||||||
**Community Organizing and Advocacy:**
|
**Community Organizing and Advocacy:**
|
||||||
- **Community organizing support** for members who want to advocate for specific changes or improvements
|
- **Community organising support** for members who want to advocate for specific changes or improvements
|
||||||
- **Coalition building assistance** helping community members with shared interests collaborate effectively on improvement initiatives
|
- **Coalition building assistance** helping community members with shared interests collaborate effectively on improvement initiatives
|
||||||
- **Advocacy training and resources** empowering community members to effectively participate in governance and change processes
|
- **Advocacy training and resources** empowering community members to effectively participate in governance and change processes
|
||||||
- **Community campaign support** for democratic initiatives that build broad community support for positive changes
|
- **Community campaign support** for democratic initiatives that build broad community support for positive changes
|
||||||
|
|
||||||
### 5.2 Crisis and Emergency Community Consultation
|
### 5.2. Crisis and Emergency Community Consultation
|
||||||
|
|
||||||
#### 5.2.1 Emergency Response Input
|
#### 5.2.1. Emergency Response Input
|
||||||
|
|
||||||
**Crisis Communication and Consultation:**
|
**Crisis Communication and Consultation:**
|
||||||
- **Emergency communication protocols** ensuring community members receive timely information about crisis decisions affecting them
|
- **Emergency communication protocols** ensuring community members receive timely information about crisis decisions affecting them
|
||||||
- **Rapid consultation processes** gathering essential community input even during emergency situations
|
- **Rapid consultation processes** gathering essential community input even during emergency situations
|
||||||
- **Community safety prioritization** balancing community input with immediate safety and security requirements
|
- **Community safety prioritisation** balancing community input with immediate safety and security requirements
|
||||||
- **Post-crisis evaluation** involving comprehensive community consultation on emergency response effectiveness and improvements
|
- **Post-crisis evaluation** involving comprehensive community consultation on emergency response effectiveness and improvements
|
||||||
|
|
||||||
#### 5.2.2 Community Healing and Recovery Participation
|
#### 5.2.2. Community Healing and Recovery Participation
|
||||||
|
|
||||||
**Collective Recovery Planning:**
|
**Collective Recovery Planning:**
|
||||||
- **Community-wide healing initiatives** developed with broad community input and participation
|
- **Community-wide healing initiatives** developed with broad community input and participation
|
||||||
@@ -264,9 +264,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
|
|
||||||
## 6. Feedback Response and Follow-Up Systems
|
## 6. Feedback Response and Follow-Up Systems
|
||||||
|
|
||||||
### 6.1 Comprehensive Response Protocols
|
### 6.1. Comprehensive Response Protocols
|
||||||
|
|
||||||
#### 6.1.1 Individual Feedback Acknowledgment
|
#### 6.1.1. Individual Feedback Acknowledgment
|
||||||
|
|
||||||
**Personal Response Commitments:**
|
**Personal Response Commitments:**
|
||||||
- **Acknowledgment within 48 hours** for all individual feedback submissions and policy input
|
- **Acknowledgment within 48 hours** for all individual feedback submissions and policy input
|
||||||
@@ -280,7 +280,7 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Outcome communication** sharing results and impacts of changes made in response to community feedback
|
- **Outcome communication** sharing results and impacts of changes made in response to community feedback
|
||||||
- **Satisfaction follow-up** ensuring community members are satisfied with how their feedback was handled and addressed
|
- **Satisfaction follow-up** ensuring community members are satisfied with how their feedback was handled and addressed
|
||||||
|
|
||||||
#### 6.1.2 Community-Wide Response Communication
|
#### 6.1.2. Community-Wide Response Communication
|
||||||
|
|
||||||
**Public Feedback Summaries:**
|
**Public Feedback Summaries:**
|
||||||
- **Monthly summary reports** highlighting community feedback themes, concerns, and suggestions received
|
- **Monthly summary reports** highlighting community feedback themes, concerns, and suggestions received
|
||||||
@@ -289,14 +289,14 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Appreciation and recognition** of community members who provide valuable feedback and participate in governance processes
|
- **Appreciation and recognition** of community members who provide valuable feedback and participate in governance processes
|
||||||
|
|
||||||
**Community Learning and Improvement:**
|
**Community Learning and Improvement:**
|
||||||
- **Best practice sharing** about effective feedback integration and community input utilization
|
- **Best practice sharing** about effective feedback integration and community input utilisation
|
||||||
- **Process improvement updates** showing how community feedback systems themselves are being enhanced based on member input
|
- **Process improvement updates** showing how community feedback systems themselves are being enhanced based on member input
|
||||||
- **Success story communication** celebrating positive changes that resulted from community feedback and participation
|
- **Success story communication** celebrating positive changes that resulted from community feedback and participation
|
||||||
- **Challenge identification** and collaborative problem-solving when feedback systems need improvement or enhancement
|
- **Challenge identification** and collaborative problem-solving when feedback systems need improvement or enhancement
|
||||||
|
|
||||||
### 6.2 Continuous Feedback System Enhancement
|
### 6.2. Continuous Feedback System Enhancement
|
||||||
|
|
||||||
#### 6.2.1 Meta-Feedback and System Improvement
|
#### 6.2.1. Meta-Feedback and System Improvement
|
||||||
|
|
||||||
**Feedback System Effectiveness Assessment:**
|
**Feedback System Effectiveness Assessment:**
|
||||||
- **Annual evaluation** of community feedback systems and their effectiveness in enabling meaningful participation
|
- **Annual evaluation** of community feedback systems and their effectiveness in enabling meaningful participation
|
||||||
@@ -312,9 +312,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
|
|
||||||
## 7. Training and Support for Community Participation
|
## 7. Training and Support for Community Participation
|
||||||
|
|
||||||
### 7.1 Civic Engagement Education
|
### 7.1. Civic Engagement Education
|
||||||
|
|
||||||
#### 7.1.1 Participation Skills Development
|
#### 7.1.1. Participation Skills Development
|
||||||
|
|
||||||
**Democratic Participation Training:**
|
**Democratic Participation Training:**
|
||||||
- **Civic engagement workshops** teaching community members effective advocacy, communication, and participation skills
|
- **Civic engagement workshops** teaching community members effective advocacy, communication, and participation skills
|
||||||
@@ -326,9 +326,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Public speaking and presentation training** for community members interested in more active governance participation
|
- **Public speaking and presentation training** for community members interested in more active governance participation
|
||||||
- **Written communication skills** development for effective policy feedback and proposal development
|
- **Written communication skills** development for effective policy feedback and proposal development
|
||||||
- **Research and analysis training** helping community members gather information and develop evidence-based suggestions
|
- **Research and analysis training** helping community members gather information and develop evidence-based suggestions
|
||||||
- **Coalition building and organizing skills** for community members interested in leading community improvement initiatives
|
- **Coalition building and organising skills** for community members interested in leading community improvement initiatives
|
||||||
|
|
||||||
#### 7.1.2 Community Governance Education
|
#### 7.1.2. Community Governance Education
|
||||||
|
|
||||||
**Governance Literacy Programs:**
|
**Governance Literacy Programs:**
|
||||||
- **Community governance orientation** for new members explaining how community decision-making works and how to participate
|
- **Community governance orientation** for new members explaining how community decision-making works and how to participate
|
||||||
@@ -336,17 +336,17 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Leadership and governance roles education** explaining different governance positions and how community members can become involved
|
- **Leadership and governance roles education** explaining different governance positions and how community members can become involved
|
||||||
- **Community history and values education** helping members understand the context and principles guiding community governance
|
- **Community history and values education** helping members understand the context and principles guiding community governance
|
||||||
|
|
||||||
### 7.2 Participation Support and Mentorship
|
### 7.2. Participation Support and Mentorship
|
||||||
|
|
||||||
#### 7.2.1 New Member Integration
|
#### 7.2.1. New Member Integration
|
||||||
|
|
||||||
**Participation Mentorship Programs:**
|
**Participation Mentorship Programmes:**
|
||||||
- **Governance mentorship** pairing experienced community members with newcomers interested in participation and feedback
|
- **Governance mentorship** pairing experienced community members with newcomers interested in participation and feedback
|
||||||
- **Peer support networks** connecting community members with similar interests in governance and community improvement
|
- **Peer support networks** connecting community members with similar interests in governance and community improvement
|
||||||
- **Guided participation experiences** providing supported opportunities for new members to engage in feedback and governance processes
|
- **Guided participation experiences** providing supported opportunities for new members to engage in feedback and governance processes
|
||||||
- **Community leadership pipeline development** identifying and supporting community members interested in greater governance involvement
|
- **Community leadership pipeline development** identifying and supporting community members interested in greater governance involvement
|
||||||
|
|
||||||
#### 7.2.2 Ongoing Participation Support
|
#### 7.2.2. Ongoing Participation Support
|
||||||
|
|
||||||
**Sustained Engagement Assistance:**
|
**Sustained Engagement Assistance:**
|
||||||
- **Resource libraries** providing ongoing access to materials, tools, and information supporting effective community participation
|
- **Resource libraries** providing ongoing access to materials, tools, and information supporting effective community participation
|
||||||
@@ -356,9 +356,9 @@ When immediate policy changes are necessary for community safety:
|
|||||||
|
|
||||||
## 8. Policy Implementation and Continuous Improvement
|
## 8. Policy Implementation and Continuous Improvement
|
||||||
|
|
||||||
### 8.1 Policy Effectiveness Evaluation
|
### 8.1. Policy Effectiveness Evaluation
|
||||||
|
|
||||||
#### 8.1.1 Regular Assessment and Enhancement
|
#### 8.1.1. Regular Assessment and Enhancement
|
||||||
|
|
||||||
**Quarterly System Review:**
|
**Quarterly System Review:**
|
||||||
- **Participation metrics assessment** analysing community engagement levels and identifying areas for improvement
|
- **Participation metrics assessment** analysing community engagement levels and identifying areas for improvement
|
||||||
@@ -372,13 +372,13 @@ When immediate policy changes are necessary for community safety:
|
|||||||
- **Community capacity building** evaluation assessing how participation systems support community member skill development and engagement
|
- **Community capacity building** evaluation assessing how participation systems support community member skill development and engagement
|
||||||
- **System innovation and improvement** planning for enhanced feedback systems and participation opportunities
|
- **System innovation and improvement** planning for enhanced feedback systems and participation opportunities
|
||||||
|
|
||||||
### 8.2 Community-Driven Policy Evolution
|
### 8.2. Community-Driven Policy Evolution
|
||||||
|
|
||||||
#### 8.2.1 Responsive Policy Development
|
#### 8.2.1. Responsive Policy Development
|
||||||
|
|
||||||
**Community-Initiated Policy Changes:**
|
**Community-Initiated Policy Changes:**
|
||||||
- **Community proposal processes** enabling members to suggest policy modifications and improvements through structured democratic processes
|
- **Community proposal processes** enabling members to suggest policy modifications and improvements through structured democratic processes
|
||||||
- **Community prioritization systems** allowing members to identify which policy areas most need attention and improvement
|
- **Community prioritisation systems** allowing members to identify which policy areas most need attention and improvement
|
||||||
- **Collaborative policy development** involving community members in drafting, reviewing, and refining policy changes
|
- **Collaborative policy development** involving community members in drafting, reviewing, and refining policy changes
|
||||||
- **Democratic approval processes** ensuring community input and consent for significant policy modifications and new policy development
|
- **Democratic approval processes** ensuring community input and consent for significant policy modifications and new policy development
|
||||||
|
|
||||||
@@ -398,4 +398,4 @@ Through this Policy, we pledge to maintain transparent, accessible, and effectiv
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Community Feedback and Participation Policy was created on 15 September 2025. For questions about community participation opportunities or to provide feedback on this Policy, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
*This Community Feedback and Participation Policy provides comprehensive information about community participation opportunities. For questions about community participation opportunities or to provide feedback on this Policy, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|||||||
+151
-151
@@ -4,15 +4,15 @@ title: Community Guidelines and Best Practices
|
|||||||
|
|
||||||
## 1. Introduction and Framework
|
## 1. Introduction and Framework
|
||||||
|
|
||||||
### 1.1 Purpose and Scope
|
### 1.1. Purpose and Scope
|
||||||
|
|
||||||
These Community Guidelines (hereinafter referred to as "the Guidelines") serve as a comprehensive framework for fostering positive, productive, and meaningful interactions within our community ecosystem. Whilst these Guidelines represent recommended best practices rather than mandatory requirements, adherence to these principles is strongly encouraged and contributes significantly to maintaining the high standards, integrity, and collaborative spirit that define our community.
|
These Community Guidelines (hereinafter referred to as "the Guidelines") serve as a comprehensive framework for fostering positive, productive, and meaningful interactions within our community ecosystem. Whilst these Guidelines represent recommended best practices rather than mandatory requirements, adherence to these principles is strongly encouraged and contributes significantly to maintaining the high standards, integrity, and collaborative spirit that define our community.
|
||||||
|
|
||||||
### 1.2 Relationship to Mandatory Policies
|
### 1.2. Relationship to Mandatory Policies
|
||||||
|
|
||||||
These Guidelines operate in conjunction with and supplement our mandatory Community Code of Conduct. Where any provision of these Guidelines conflicts with our Code of Conduct, the Code of Conduct shall take precedence as the binding standard. Nothing contained within these Guidelines shall supersede, modify, or diminish the requirements established by our Code of Conduct.
|
These Guidelines operate in conjunction with and supplement our mandatory Community Code of Conduct. Where any provision of these Guidelines conflicts with our Code of Conduct, the Code of Conduct shall take precedence as the binding standard. Nothing contained within these Guidelines shall supersede, modify, or diminish the requirements established by our Code of Conduct.
|
||||||
|
|
||||||
### 1.3 Community Objectives
|
### 1.3. Community Objectives
|
||||||
|
|
||||||
The primary objectives of these Guidelines are to:
|
The primary objectives of these Guidelines are to:
|
||||||
1. **Promote Excellence**: Encourage high-quality contributions and meaningful dialogue
|
1. **Promote Excellence**: Encourage high-quality contributions and meaningful dialogue
|
||||||
@@ -21,7 +21,7 @@ The primary objectives of these Guidelines are to:
|
|||||||
4. **Maintain Standards**: Preserve the professional and collaborative atmosphere that characterises our community
|
4. **Maintain Standards**: Preserve the professional and collaborative atmosphere that characterises our community
|
||||||
5. **Encourage Participation**: Provide clear guidance for constructive engagement at all levels
|
5. **Encourage Participation**: Provide clear guidance for constructive engagement at all levels
|
||||||
|
|
||||||
### 1.4 Voluntary Nature and Benefits
|
### 1.4. Voluntary Nature and Benefits
|
||||||
|
|
||||||
Whilst compliance with these Guidelines is voluntary, community members who consistently demonstrate these behaviours typically experience:
|
Whilst compliance with these Guidelines is voluntary, community members who consistently demonstrate these behaviours typically experience:
|
||||||
- Enhanced reputation and standing within the community
|
- Enhanced reputation and standing within the community
|
||||||
@@ -31,45 +31,45 @@ Whilst compliance with these Guidelines is voluntary, community members who cons
|
|||||||
|
|
||||||
## 2. Staff Interaction and Professional Relationships
|
## 2. Staff Interaction and Professional Relationships
|
||||||
|
|
||||||
### 2.1 Recognition of Voluntary Service
|
### 2.1. Recognition of Voluntary Service
|
||||||
|
|
||||||
Our community staff members, including moderators, administrators, and support personnel, generously volunteer their time, expertise, and energy to maintain safe, welcoming, and productive community environments. These individuals dedicate significant personal resources to ensure that our community remains accessible, secure, and beneficial for all participants.
|
Our community staff members, including moderators, administrators, and support personnel, generously volunteer their time, expertise, and energy to maintain safe, welcoming, and productive community environments. These individuals dedicate significant personal resources to ensure that our community remains accessible, secure, and beneficial for all participants.
|
||||||
|
|
||||||
### 2.2 Professional Courtesy and Respect
|
### 2.2. Professional Courtesy and Respect
|
||||||
|
|
||||||
#### 2.2.1 Fundamental Principles
|
#### 2.2.1. Fundamental Principles
|
||||||
Community members are encouraged to demonstrate professional courtesy and respect in all interactions with staff by:
|
Community members are encouraged to demonstrate professional courtesy and respect in all interactions with staff by:
|
||||||
- Acknowledging the challenges inherent in moderating online communities
|
- Acknowledging the challenges inherent in moderating online communities
|
||||||
- Recognising that staff members are volunteers balancing community service with personal commitments
|
- Recognising that staff members are volunteers balancing community service with personal commitments
|
||||||
- Approaching staff interactions with patience, understanding, and constructive intent
|
- Approaching staff interactions with patience, understanding, and constructive intent
|
||||||
- Expressing gratitude for staff efforts and contributions when appropriate
|
- Expressing gratitude for staff efforts and contributions when appropriate
|
||||||
|
|
||||||
#### 2.2.2 Communication Standards
|
#### 2.2.2. Communication Standards
|
||||||
Effective communication with staff members should demonstrate:
|
Effective communication with staff members should demonstrate:
|
||||||
- Clear, respectful, and professional language
|
- Clear, respectful, and professional language
|
||||||
- Specific descriptions of issues or concerns rather than general complaints
|
- Specific descriptions of issues or concerns rather than general complaints
|
||||||
- Constructive suggestions for improvement when raising concerns
|
- Constructive suggestions for improvement when raising concerns
|
||||||
- Recognition of resource constraints and competing priorities
|
- Recognition of resource constraints and competing priorities
|
||||||
|
|
||||||
### 2.3 Staff Authority and Decision-Making Process
|
### 2.3. Staff Authority and Decision-Making Process
|
||||||
|
|
||||||
#### 2.3.1 Scope of Authority
|
#### 2.3.1. Scope of Authority
|
||||||
Staff members are vested with authority to make decisions necessary for maintaining community safety, order, and positive atmosphere. This authority includes, but is not limited to:
|
Staff members are vested with authority to make decisions necessary for maintaining community safety, order, and positive atmosphere. This authority includes, but is not limited to:
|
||||||
- Interpreting and applying community policies and guidelines
|
- Interpreting and applying community policies and guidelines
|
||||||
- Managing community resources and access permissions
|
- Managing community resources and access permissions
|
||||||
- Addressing conflicts and disciplinary matters
|
- Addressing conflicts and disciplinary matters
|
||||||
- Implementing changes to improve community operations
|
- Implementing changes to improve community operations
|
||||||
|
|
||||||
#### 2.3.2 Recognition of Human Limitations
|
#### 2.3.2. Recognition of Human Limitations
|
||||||
Community members should recognise that staff members, being human, may occasionally:
|
Community members should recognise that staff members, being human, may occasionally:
|
||||||
- Make decisions that appear inconsistent or questionable
|
- Make decisions that appear inconsistent or questionable
|
||||||
- Experience variations in judgement due to personal circumstances
|
- Experience variations in judgement due to personal circumstances
|
||||||
- Require additional information to make fully informed decisions
|
- Require additional information to make fully informed decisions
|
||||||
- Benefit from constructive feedback and alternative perspectives
|
- Benefit from constructive feedback and alternative perspectives
|
||||||
|
|
||||||
### 2.4 Dispute Resolution and Appeals Process
|
### 2.4. Dispute Resolution and Appeals Process
|
||||||
|
|
||||||
#### 2.4.1 Constructive Approach to Disagreements
|
#### 2.4.1. Constructive Approach to Disagreements
|
||||||
When community members disagree with staff decisions, the recommended approach includes:
|
When community members disagree with staff decisions, the recommended approach includes:
|
||||||
|
|
||||||
1. **Pause and Reflect**: Allow time for emotional responses to subside before responding
|
1. **Pause and Reflect**: Allow time for emotional responses to subside before responding
|
||||||
@@ -77,22 +77,22 @@ When community members disagree with staff decisions, the recommended approach i
|
|||||||
3. **Consider Alternative Perspectives**: Attempt to understand the rationale behind staff decisions
|
3. **Consider Alternative Perspectives**: Attempt to understand the rationale behind staff decisions
|
||||||
4. **Document Concerns**: Prepare clear, factual descriptions of specific issues
|
4. **Document Concerns**: Prepare clear, factual descriptions of specific issues
|
||||||
|
|
||||||
#### 2.4.2 Inappropriate Response Patterns
|
#### 2.4.2. Inappropriate Response Patterns
|
||||||
Community members should avoid the following counterproductive behaviours:
|
Community members should avoid the following counterproductive behaviours:
|
||||||
- Direct confrontation or argumentative challenges to staff authority
|
- Direct confrontation or argumentative challenges to staff authority
|
||||||
- Public criticism or undermining of staff decisions
|
- Public criticism or undermining of staff decisions
|
||||||
- Emotional outbursts or personal attacks directed at staff members
|
- Emotional outbursts or personal attacks directed at staff members
|
||||||
- Demands for immediate resolution without allowing adequate consideration time
|
- Demands for immediate resolution without allowing adequate consideration time
|
||||||
|
|
||||||
#### 2.4.3 Formal Appeals Process Reference
|
#### 2.4.3. Formal Appeals Process Reference
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive appeals procedures, including confidential review processes, impartial assessment protocols, and accessibility standards, are set forth in our dedicated [Appeals Process](/community/appeal) document.**
|
**IMPORTANT: Comprehensive appeals procedures, including confidential review processes, impartial assessment protocols, and accessibility standards, are set forth in our dedicated [Appeals Process](/community/appeal) document.**
|
||||||
|
|
||||||
For situations where informal resolution is insufficient, our formal appeals process provides independent, confidential review with fair consideration of all perspectives and transparent communication of outcomes.
|
For situations where informal resolution is insufficient, our formal appeals process provides independent, confidential review with fair consideration of all perspectives and transparent communication of outcomes.
|
||||||
|
|
||||||
### 2.6 Post-Sanction Conduct and Improvement
|
### 2.6. Post-Sanction Conduct and Improvement
|
||||||
|
|
||||||
#### 2.6.1 Constructive Response to Disciplinary Actions
|
#### 2.6.1. Constructive Response to Disciplinary Actions
|
||||||
Community members who receive disciplinary sanctions are encouraged to:
|
Community members who receive disciplinary sanctions are encouraged to:
|
||||||
|
|
||||||
**Positive Actions:**
|
**Positive Actions:**
|
||||||
@@ -103,7 +103,7 @@ Community members who receive disciplinary sanctions are encouraged to:
|
|||||||
- Maintain respectful, professional demeanour in all subsequent interactions
|
- Maintain respectful, professional demeanour in all subsequent interactions
|
||||||
- Focus on contributing positively to community discussions and activities
|
- Focus on contributing positively to community discussions and activities
|
||||||
|
|
||||||
#### 2.6.2 Counterproductive Response Patterns
|
#### 2.6.2. Counterproductive Response Patterns
|
||||||
Community members should avoid the following behaviours following disciplinary actions:
|
Community members should avoid the following behaviours following disciplinary actions:
|
||||||
- Continuing the sanctioned behaviour in modified or disguised forms
|
- Continuing the sanctioned behaviour in modified or disguised forms
|
||||||
- Attempting to circumvent policies through technical loopholes or creative interpretations
|
- Attempting to circumvent policies through technical loopholes or creative interpretations
|
||||||
@@ -111,7 +111,7 @@ Community members should avoid the following behaviours following disciplinary a
|
|||||||
- Engaging in comparative arguments about other members' conduct or perceived inconsistencies
|
- Engaging in comparative arguments about other members' conduct or perceived inconsistencies
|
||||||
- Displaying resentment, hostility, or non-cooperation with staff or community standards
|
- Displaying resentment, hostility, or non-cooperation with staff or community standards
|
||||||
|
|
||||||
#### 2.6.3 Growth and Learning Opportunities
|
#### 2.6.3. Growth and Learning Opportunities
|
||||||
Disciplinary situations, whilst challenging, offer opportunities for:
|
Disciplinary situations, whilst challenging, offer opportunities for:
|
||||||
- Personal growth and improved self-awareness
|
- Personal growth and improved self-awareness
|
||||||
- Enhanced understanding of community standards and expectations
|
- Enhanced understanding of community standards and expectations
|
||||||
@@ -120,29 +120,29 @@ Disciplinary situations, whilst challenging, offer opportunities for:
|
|||||||
|
|
||||||
## 3. Plural Systems Support and Inclusivity
|
## 3. Plural Systems Support and Inclusivity
|
||||||
|
|
||||||
### 3.1 Understanding and Recognition
|
### 3.1. Understanding and Recognition
|
||||||
|
|
||||||
#### 3.1.1 Definitions and Concepts
|
#### 3.1.1. Definitions and Concepts
|
||||||
Plural systems refer to individuals who experience multiple distinct identities, personality states, or conscious entities sharing a single physical body. These identities, commonly referred to as "alters," "headmates," or "system members," may have different names, preferences, communication styles, and roles within the system's functioning.
|
Plural systems refer to individuals who experience multiple distinct identities, personality states, or conscious entities sharing a single physical body. These identities, commonly referred to as "alters," "headmates," or "system members," may have different names, preferences, communication styles, and roles within the system's functioning.
|
||||||
|
|
||||||
#### 3.1.2 Community Commitment to Inclusion
|
#### 3.1.2. Community Commitment to Inclusion
|
||||||
Our community explicitly recognises, values, and supports plural systems as full and equal members. We are committed to:
|
Our community explicitly recognises, values, and supports plural systems as full and equal members. We are committed to:
|
||||||
- Creating safe, welcoming environments for all system members
|
- Creating safe, welcoming environments for all system members
|
||||||
- Respecting the autonomy and validity of plural experiences
|
- Respecting the autonomy and validity of plural experiences
|
||||||
- Supporting system members' right to self-identification and expression
|
- Supporting system members' right to self-identification and expression
|
||||||
- Promoting understanding and acceptance throughout our community
|
- Promoting understanding and acceptance throughout our community
|
||||||
|
|
||||||
### 3.2 Respectful Interaction Guidelines
|
### 3.2. Respectful Interaction Guidelines
|
||||||
|
|
||||||
#### 3.2.1 Privacy and Boundaries
|
#### 3.2.1. Privacy and Boundaries
|
||||||
Community members should demonstrate respect for plural systems by:
|
Community members should demonstrate respect for plural systems by:
|
||||||
- **Respecting Privacy**: Never pressuring systems to disclose information about their plurality, individual alters, or system dynamics
|
- **Respecting Privacy**: Never pressuring systems to disclose information about their plurality, individual alters, or system dynamics
|
||||||
- **Honouring Boundaries**: Accepting the level of information systems choose to share without requesting additional details
|
- **Honouring Boundaries**: Accepting the level of information systems choose to share without requesting additional details
|
||||||
- **Avoiding Assumptions**: Not making judgements about system validity, formation, or functioning based on limited information
|
- **Avoiding Assumptions**: Not making judgements about system validity, formation, or functioning based on limited information
|
||||||
- **Supporting Autonomy**: Recognising systems' right to manage their own disclosure and participation decisions
|
- **Supporting Autonomy**: Recognising systems' right to manage their own disclosure and participation decisions
|
||||||
|
|
||||||
#### 3.2.2 Prohibited Behaviours
|
#### 3.2.2. Prohibited Behaviours
|
||||||
**Reference to Comprehensive Policies**: Detailed harassment definitions, prohibited behaviors, and enforcement procedures are comprehensively covered in our Acceptable Use Policy and Content and Moderation Policy, which are incorporated herein by reference.
|
**Reference to Comprehensive Policies**: Detailed harassment definitions, prohibited behaviours, and enforcement procedures are comprehensively covered in our Acceptable Use Policy and Content and Moderation Policy, which are incorporated herein by reference.
|
||||||
|
|
||||||
Additional community-specific inappropriate behaviours include:
|
Additional community-specific inappropriate behaviours include:
|
||||||
- Attempting to identify which alter is "fronting" (actively controlling the body) without permission
|
- Attempting to identify which alter is "fronting" (actively controlling the body) without permission
|
||||||
@@ -151,32 +151,32 @@ Additional community-specific inappropriate behaviours include:
|
|||||||
- Making unsolicited comments about the causes or origins of plurality
|
- Making unsolicited comments about the causes or origins of plurality
|
||||||
- Offering unwanted advice about system management or integration
|
- Offering unwanted advice about system management or integration
|
||||||
|
|
||||||
### 3.3 Communication Best Practices
|
### 3.3. Communication Best Practices
|
||||||
|
|
||||||
#### 3.3.1 Appropriate Addressing and Recognition
|
#### 3.3.1. Appropriate Addressing and Recognition
|
||||||
When interacting with plural systems:
|
When interacting with plural systems:
|
||||||
- **Use Preferred Names and Pronouns**: Address individual alters by their chosen names and pronouns when known
|
- **Use Preferred Names and Pronouns**: Address individual alters by their chosen names and pronouns when known
|
||||||
- **Ask for Clarification Respectfully**: If uncertain about how to address someone, politely request guidance
|
- **Ask for Clarification Respectfully**: If uncertain about how to address someone, politely request guidance
|
||||||
- **Adapt to Communication Styles**: Recognise that different alters may have distinct communication preferences and styles
|
- **Adapt to Communication Styles**: Recognise that different alters may have distinct communication preferences and styles
|
||||||
- **Maintain Consistency**: Remember and apply individual preferences across interactions when possible
|
- **Maintain Consistency**: Remember and apply individual preferences across interactions when possible
|
||||||
|
|
||||||
#### 3.3.2 Switching and Communication Changes
|
#### 3.3.2. Switching and Communication Changes
|
||||||
Community members should understand that:
|
Community members should understand that:
|
||||||
- Different alters may participate in conversations at different times (switching)
|
- Different alters may participate in conversations at different times (switching)
|
||||||
- Communication styles, interests, or responses may change when different alters are active
|
- Communication styles, interests, or responses may change when different alters are active
|
||||||
- Systems may need time to communicate internally or may experience communication delays
|
- Systems may need time to communicate internally or may experience communication delays
|
||||||
- Patience and flexibility enhance positive interactions with plural community members
|
- Patience and flexibility enhance positive interactions with plural community members
|
||||||
|
|
||||||
### 3.4 Educational Approach and Community Development
|
### 3.4. Educational Approach and Community Development
|
||||||
|
|
||||||
#### 3.4.1 Promoting Understanding
|
#### 3.4.1. Promoting Understanding
|
||||||
Our community encourages education about plurality through:
|
Our community encourages education about plurality through:
|
||||||
- Sharing of appropriate educational resources and information
|
- Sharing of appropriate educational resources and information
|
||||||
- Respectful dialogue about plural experiences when welcomed by system members
|
- Respectful dialogue about plural experiences when welcomed by system members
|
||||||
- Community-wide initiatives to increase awareness and acceptance
|
- Community-wide initiatives to increase awareness and acceptance
|
||||||
- Training for staff members on inclusive practices for plural individuals
|
- Training for staff members on inclusive practices for plural individuals
|
||||||
|
|
||||||
#### 3.4.2 Resource Direction and Support
|
#### 3.4.2. Resource Direction and Support
|
||||||
Rather than placing educational burdens on individual systems:
|
Rather than placing educational burdens on individual systems:
|
||||||
- Direct general questions about plurality to appropriate educational resources
|
- Direct general questions about plurality to appropriate educational resources
|
||||||
- Consult established literature, organisations, or informational websites
|
- Consult established literature, organisations, or informational websites
|
||||||
@@ -185,9 +185,9 @@ Rather than placing educational burdens on individual systems:
|
|||||||
|
|
||||||
## 4. Tone Tags and Communication Enhancement
|
## 4. Tone Tags and Communication Enhancement
|
||||||
|
|
||||||
### 4.1 Understanding Tone Tags and Their Purpose
|
### 4.1. Understanding Tone Tags and Their Purpose
|
||||||
|
|
||||||
#### 4.1.1 Communication Challenges in Text-Based Environments
|
#### 4.1.1. Communication Challenges in Text-Based Environments
|
||||||
Text-based communication inherently lacks many contextual cues available in face-to-face interaction, including:
|
Text-based communication inherently lacks many contextual cues available in face-to-face interaction, including:
|
||||||
- Vocal tone, inflection, and emphasis
|
- Vocal tone, inflection, and emphasis
|
||||||
- Facial expressions and body language
|
- Facial expressions and body language
|
||||||
@@ -196,12 +196,12 @@ Text-based communication inherently lacks many contextual cues available in face
|
|||||||
|
|
||||||
These limitations frequently lead to misunderstandings, misinterpretations, and unnecessary conflicts within online communities.
|
These limitations frequently lead to misunderstandings, misinterpretations, and unnecessary conflicts within online communities.
|
||||||
|
|
||||||
#### 4.1.2 Solution: Tone Tags as Communication Tools
|
#### 4.1.2. Solution: Tone Tags as Communication Tools
|
||||||
Tone tags represent a systematic approach to addressing these communication challenges by providing explicit contextual information about the intended tone, purpose, or emotional content of messages. These brief, standardised indicators help clarify intent and reduce misunderstandings.
|
Tone tags represent a systematic approach to addressing these communication challenges by providing explicit contextual information about the intended tone, purpose, or emotional content of messages. These brief, standardised indicators help clarify intent and reduce misunderstandings.
|
||||||
|
|
||||||
### 4.2 Strategic Application of Tone Tags
|
### 4.2. Strategic Application of Tone Tags
|
||||||
|
|
||||||
#### 4.2.1 Optimal Usage Scenarios
|
#### 4.2.1. Optimal Usage Scenarios
|
||||||
Consider implementing tone tags in the following circumstances:
|
Consider implementing tone tags in the following circumstances:
|
||||||
- **Ambiguous Content**: Messages that could reasonably be interpreted in multiple ways
|
- **Ambiguous Content**: Messages that could reasonably be interpreted in multiple ways
|
||||||
- **Humour and Sarcasm**: Content intended as humorous, sarcastic, or ironic that might not be immediately apparent
|
- **Humour and Sarcasm**: Content intended as humorous, sarcastic, or ironic that might not be immediately apparent
|
||||||
@@ -209,23 +209,23 @@ Consider implementing tone tags in the following circumstances:
|
|||||||
- **Cross-Cultural Communication**: Interactions with individuals from different cultural or linguistic backgrounds
|
- **Cross-Cultural Communication**: Interactions with individuals from different cultural or linguistic backgrounds
|
||||||
- **Accessibility Needs**: Communication with individuals who have expressed difficulty interpreting textual tone
|
- **Accessibility Needs**: Communication with individuals who have expressed difficulty interpreting textual tone
|
||||||
|
|
||||||
#### 4.2.2 Preventive Communication Strategy
|
#### 4.2.2. Preventive Communication Strategy
|
||||||
Proactive use of tone tags can prevent:
|
Proactive use of tone tags can prevent:
|
||||||
- Escalation of minor misunderstandings into significant conflicts
|
- Escalation of minor misunderstandings into significant conflicts
|
||||||
- Emotional distress caused by misinterpretation of intent
|
- Emotional distress caused by misinterpretation of intent
|
||||||
- Time-consuming clarification discussions
|
- Time-consuming clarification discussions
|
||||||
- Damage to relationships and community trust
|
- Damage to relationships and community trust
|
||||||
|
|
||||||
### 4.3 Implementation Guidelines and Best Practices
|
### 4.3. Implementation Guidelines and Best Practices
|
||||||
|
|
||||||
#### 4.3.1 Formatting and Placement Standards
|
#### 4.3.1. Formatting and Placement Standards
|
||||||
Effective tone tag implementation involves:
|
Effective tone tag implementation involves:
|
||||||
- **Location**: Place tone tags at the end of the relevant message or section
|
- **Location**: Place tone tags at the end of the relevant message or section
|
||||||
- **Format**: Enclose tags in forward slashes, e.g., `/j` for joking
|
- **Format**: Enclose tags in forward slashes, e.g., `/j` for joking
|
||||||
- **Multiple Tags**: Use multiple tags when appropriate, e.g., `/s /lh` for sarcastic but lighthearted
|
- **Multiple Tags**: Use multiple tags when appropriate, e.g., `/s /lh` for sarcastic but lighthearted
|
||||||
- **Consistency**: Apply tags consistently across similar communication contexts
|
- **Consistency**: Apply tags consistently across similar communication contexts
|
||||||
|
|
||||||
#### 4.3.2 Comprehensive Tone Tag Reference
|
#### 4.3.2. Comprehensive Tone Tag Reference
|
||||||
|
|
||||||
| Tag | Meaning | Usage Context |
|
| Tag | Meaning | Usage Context |
|
||||||
|------------------------|--------------------------------------|--------------------------------------------------|
|
|------------------------|--------------------------------------|--------------------------------------------------|
|
||||||
@@ -281,32 +281,32 @@ Effective tone tag implementation involves:
|
|||||||
| `/t` | Teasing | Engaging in playful, non-malicious mockery |
|
| `/t` | Teasing | Engaging in playful, non-malicious mockery |
|
||||||
| `/tc`, `/ti` or `/tic` | Typing a Tic | Indicating involuntary typing behaviour |
|
| `/tc`, `/ti` or `/tic` | Typing a Tic | Indicating involuntary typing behaviour |
|
||||||
|
|
||||||
### 4.4 Community Etiquette and Respect
|
### 4.4. Community Etiquette and Respect
|
||||||
|
|
||||||
#### 4.4.1 Respectful Response to Tone Tags
|
#### 4.4.1. Respectful Response to Tone Tags
|
||||||
Community members should demonstrate respect for tone tag usage by:
|
Community members should demonstrate respect for tone tag usage by:
|
||||||
- **Interpreting Appropriately**: Adjust message interpretation based on provided tone tags
|
- **Interpreting Appropriately**: Adjust message interpretation based on provided tone tags
|
||||||
- **Seeking Clarification**: Politely request explanation for unfamiliar or unclear tags
|
- **Seeking Clarification**: Politely request explanation for unfamiliar or unclear tags
|
||||||
- **Avoiding Mockery**: Never belittle, mock, or criticise others for using tone tags
|
- **Avoiding Mockery**: Never belittle, mock, or criticise others for using tone tags
|
||||||
- **Supporting Usage**: Encourage tone tag adoption when it would enhance communication
|
- **Supporting Usage**: Encourage tone tag adoption when it would enhance communication
|
||||||
|
|
||||||
#### 4.4.2 Accessibility and Inclusion Benefits
|
#### 4.4.2. Accessibility and Inclusion Benefits
|
||||||
Tone tags particularly benefit:
|
Tone tags particularly benefit:
|
||||||
- **Neurodivergent Individuals**: People who may experience difficulty interpreting social cues or implied meanings
|
- **Neurodivergent Individuals**: People who may experience difficulty interpreting social cues or implied meanings
|
||||||
- **Non-Native Speakers**: Individuals for whom English cultural and linguistic nuances may be challenging
|
- **Non-Native Speakers**: Individuals for whom English cultural and linguistic nuances may be challenging
|
||||||
- **Screen Reader Users**: People using assistive technology who can access tone tag information
|
- **Screen Reader Users**: People using assistive technology who can access tone tag information
|
||||||
- **Anxiety-Prone Communicators**: Individuals who benefit from explicit clarification of intent
|
- **Anxiety-Prone Communicators**: Individuals who benefit from explicit clarification of intent
|
||||||
|
|
||||||
### 4.5 Limitations and Complementary Practices
|
### 4.5. Limitations and Complementary Practices
|
||||||
|
|
||||||
#### 4.5.1 Recognising Tool Limitations
|
#### 4.5.1. Recognising Tool Limitations
|
||||||
Whilst tone tags enhance communication, they should not replace:
|
Whilst tone tags enhance communication, they should not replace:
|
||||||
- Clear, well-structured writing
|
- Clear, well-structured writing
|
||||||
- Thoughtful consideration of audience and context
|
- Thoughtful consideration of audience and context
|
||||||
- Direct communication when clarity is essential
|
- Direct communication when clarity is essential
|
||||||
- Professional writing standards in formal contexts
|
- Professional writing standards in formal contexts
|
||||||
|
|
||||||
#### 4.5.2 Community-Specific Adaptations
|
#### 4.5.2. Community-Specific Adaptations
|
||||||
Our community may develop additional tone tags to address specific needs:
|
Our community may develop additional tone tags to address specific needs:
|
||||||
- **Community Consensus**: New tags adopted through collective agreement and usage
|
- **Community Consensus**: New tags adopted through collective agreement and usage
|
||||||
- **Documentation Updates**: Regular updates to tone tag references and guidelines
|
- **Documentation Updates**: Regular updates to tone tag references and guidelines
|
||||||
@@ -314,28 +314,28 @@ Our community may develop additional tone tags to address specific needs:
|
|||||||
|
|
||||||
## 5. Pronoun Usage and Gender Inclusivity
|
## 5. Pronoun Usage and Gender Inclusivity
|
||||||
|
|
||||||
### 5.1 Importance of Accurate Pronoun Usage
|
### 5.1. Importance of Accurate Pronoun Usage
|
||||||
|
|
||||||
#### 5.1.1 Fundamental Principle of Respect
|
#### 5.1.1. Fundamental Principle of Respect
|
||||||
Pronouns represent a fundamental aspect of personal identity and self-expression. Using individuals' correct pronouns demonstrates basic respect for their identity and contributes to creating inclusive environments where all community members can participate authentically and comfortably.
|
Pronouns represent a fundamental aspect of personal identity and self-expression. Using individuals' correct pronouns demonstrates basic respect for their identity and contributes to creating inclusive environments where all community members can participate authentically and comfortably.
|
||||||
|
|
||||||
#### 5.1.2 Community Values and Commitment
|
#### 5.1.2. Community Values and Commitment
|
||||||
Our community is committed to:
|
Our community is committed to:
|
||||||
- **Universal Respect**: Treating all gender identities with equal dignity and consideration
|
- **Universal Respect**: Treating all gender identities with equal dignity and consideration
|
||||||
- **Inclusive Practices**: Implementing systems and practices that accommodate diverse pronoun preferences
|
- **Inclusive Practices**: Implementing systems and practices that accommodate diverse pronoun preferences
|
||||||
- **Educational Support**: Providing resources and guidance to help community members learn inclusive practices
|
- **Educational Support**: Providing resources and guidance to help community members learn inclusive practices
|
||||||
- **Safe Expression**: Creating environments where individuals feel secure expressing their authentic identities
|
- **Safe Expression**: Creating environments where individuals feel secure expressing their authentic identities
|
||||||
|
|
||||||
### 5.2 Pronoun Sharing and Display
|
### 5.2. Pronoun Sharing and Display
|
||||||
|
|
||||||
#### 5.2.1 Encouraging Universal Participation
|
#### 5.2.1. Encouraging Universal Participation
|
||||||
We strongly encourage all community members to display their pronouns regardless of gender identity through:
|
We strongly encourage all community members to display their pronouns regardless of gender identity through:
|
||||||
- **Profile Information**: Including pronouns in bio sections and profile descriptions
|
- **Profile Information**: Including pronouns in bio sections and profile descriptions
|
||||||
- **Platform Features**: Utilising designated pronoun roles, badges, or comparable features when available
|
- **Platform Features**: Utilising designated pronoun roles, badges, or comparable features when available
|
||||||
- **Display Names**: Incorporating pronouns into usernames or display names when desired
|
- **Display Names**: Incorporating pronouns into usernames or display names when desired
|
||||||
- **Signature Lines**: Adding pronouns to forum signatures or communication templates
|
- **Signature Lines**: Adding pronouns to forum signatures or communication templates
|
||||||
|
|
||||||
#### 5.2.2 Benefits of Universal Pronoun Sharing
|
#### 5.2.2. Benefits of Universal Pronoun Sharing
|
||||||
Universal pronoun sharing creates numerous community benefits:
|
Universal pronoun sharing creates numerous community benefits:
|
||||||
|
|
||||||
**Individual Benefits:**
|
**Individual Benefits:**
|
||||||
@@ -349,16 +349,16 @@ Universal pronoun sharing creates numerous community benefits:
|
|||||||
- **Education**: Raises awareness about gender diversity and respectful practices
|
- **Education**: Raises awareness about gender diversity and respectful practices
|
||||||
- **Safety**: Reduces the risk of inadvertent outing or identity disclosure
|
- **Safety**: Reduces the risk of inadvertent outing or identity disclosure
|
||||||
|
|
||||||
### 5.3 Respectful Pronoun Practices
|
### 5.3. Respectful Pronoun Practices
|
||||||
|
|
||||||
#### 5.3.1 Consistent Usage Standards
|
#### 5.3.1. Consistent Usage Standards
|
||||||
Community members should consistently:
|
Community members should consistently:
|
||||||
- **Use Specified Pronouns**: Always employ the pronouns individuals have indicated for themselves
|
- **Use Specified Pronouns**: Always employ the pronouns individuals have indicated for themselves
|
||||||
- **Ask When Uncertain**: Politely request pronoun information when it is not readily available
|
- **Ask When Uncertain**: Politely request pronoun information when it is not readily available
|
||||||
- **Correct Mistakes Promptly**: Acknowledge errors briefly, correct usage, and continue conversations
|
- **Correct Mistakes Promptly**: Acknowledge errors briefly, correct usage, and continue conversations
|
||||||
- **Avoid Assumptions**: Never assume pronouns based on appearance, name, or other characteristics
|
- **Avoid Assumptions**: Never assume pronouns based on appearance, name, or other characteristics
|
||||||
|
|
||||||
#### 5.3.2 Error Correction Protocol
|
#### 5.3.2. Error Correction Protocol
|
||||||
When pronoun mistakes occur:
|
When pronoun mistakes occur:
|
||||||
|
|
||||||
**For the Person Making the Error:**
|
**For the Person Making the Error:**
|
||||||
@@ -372,9 +372,9 @@ When pronoun mistakes occur:
|
|||||||
2. **Support the Individual**: Check privately with misgendered individuals if they need support
|
2. **Support the Individual**: Check privately with misgendered individuals if they need support
|
||||||
3. **Avoid Public Scenes**: Don't create dramatic confrontations over honest mistakes
|
3. **Avoid Public Scenes**: Don't create dramatic confrontations over honest mistakes
|
||||||
|
|
||||||
### 5.4 Diverse Pronoun Options and Recognition
|
### 5.4. Diverse Pronoun Options and Recognition
|
||||||
|
|
||||||
#### 5.4.1 Comprehensive Pronoun Spectrum
|
#### 5.4.1. Comprehensive Pronoun Spectrum
|
||||||
Community members may use various pronoun sets including:
|
Community members may use various pronoun sets including:
|
||||||
|
|
||||||
**Traditional Pronouns:**
|
**Traditional Pronouns:**
|
||||||
@@ -393,39 +393,39 @@ Community members may use various pronoun sets including:
|
|||||||
- Name only: People who prefer their name used instead of pronouns
|
- Name only: People who prefer their name used instead of pronouns
|
||||||
- Multiple sets: Individuals who use different pronouns in different contexts
|
- Multiple sets: Individuals who use different pronouns in different contexts
|
||||||
|
|
||||||
#### 5.4.2 Evolving and Changing Pronouns
|
#### 5.4.2. Evolving and Changing Pronouns
|
||||||
Community members should understand that:
|
Community members should understand that:
|
||||||
- **Pronouns May Change**: Individuals have the right to modify their pronouns at any time
|
- **Pronouns May Change**: Individuals have the right to modify their pronouns at any time
|
||||||
- **Historical Accuracy**: Always use current pronouns, even when discussing past events
|
- **Historical Accuracy**: Always use current pronouns, even when discussing past events
|
||||||
- **No Explanation Required**: Pronoun changes do not require justification or detailed explanation
|
- **No Explanation Required**: Pronoun changes do not require justification or detailed explanation
|
||||||
- **Immediate Implementation**: Begin using new pronouns as soon as you become aware of changes
|
- **Immediate Implementation**: Begin using new pronouns as soon as you become aware of changes
|
||||||
|
|
||||||
### 5.5 Community Support and Education
|
### 5.5. Community Support and Education
|
||||||
|
|
||||||
#### 5.5.1 Creating Learning Opportunities
|
#### 5.5.1. Creating Learning Opportunities
|
||||||
Our community supports pronoun education through:
|
Our community supports pronoun education through:
|
||||||
- **Resource Sharing**: Providing educational materials about gender identity and pronoun usage
|
- **Resource Sharing**: Providing educational materials about gender identity and pronoun usage
|
||||||
- **Community Discussion**: Facilitating respectful conversations about inclusive practices
|
- **Community Discussion**: Facilitating respectful conversations about inclusive practices
|
||||||
- **Mentorship Programs**: Connecting experienced community members with newcomers learning inclusive practices
|
- **Mentorship Programmes**: Connecting experienced community members with newcomers learning inclusive practices
|
||||||
- **Regular Updates**: Sharing information about evolving best practices and community standards
|
- **Regular Updates**: Sharing information about evolving best practices and community standards
|
||||||
|
|
||||||
#### 5.5.2 Addressing Challenges and Resistance
|
#### 5.5.2. Addressing Challenges and Resistance
|
||||||
When community members experience difficulty with pronoun usage:
|
When community members experience difficulty with pronoun usage:
|
||||||
- **Educational Approach**: Provide patient education and resources rather than immediate punishment
|
- **Educational Approach**: Provide patient education and resources rather than immediate punishment
|
||||||
- **Cultural Sensitivity**: Acknowledge different cultural backgrounds whilst maintaining community standards
|
- **Cultural Sensitivity**: Acknowledge different cultural backgrounds whilst maintaining community standards
|
||||||
- **Progressive Improvement**: Recognise that learning takes time and celebrate progress over perfection
|
- **Progressive Improvement**: Recognise that learning takes time and celebrate progress over perfection
|
||||||
- **Clear Boundaries**: Maintain firm standards whilst providing supportive learning environments
|
- **Clear Boundaries**: Maintain firm standards whilst providing supportive learning environments
|
||||||
|
|
||||||
### 5.6 Privacy and Consent Considerations
|
### 5.6. Privacy and Consent Considerations
|
||||||
|
|
||||||
#### 5.6.1 Voluntary Disclosure
|
#### 5.6.1. Voluntary Disclosure
|
||||||
Whilst pronoun sharing is strongly encouraged, community members should understand that:
|
Whilst pronoun sharing is strongly encouraged, community members should understand that:
|
||||||
- **Personal Choice**: Pronoun sharing remains ultimately voluntary and personal
|
- **Personal Choice**: Pronoun sharing remains ultimately voluntary and personal
|
||||||
- **No Pressure**: Never pressure individuals to disclose pronouns if they are uncomfortable doing so
|
- **No Pressure**: Never pressure individuals to disclose pronouns if they are uncomfortable doing so
|
||||||
- **Privacy Respect**: Some individuals may have complex reasons for not sharing pronouns publicly
|
- **Privacy Respect**: Some individuals may have complex reasons for not sharing pronouns publicly
|
||||||
- **Alternative Solutions**: Find respectful ways to communicate without pronouns when necessary
|
- **Alternative Solutions**: Find respectful ways to communicate without pronouns when necessary
|
||||||
|
|
||||||
#### 5.6.2 Confidentiality and Safety
|
#### 5.6.2. Confidentiality and Safety
|
||||||
In certain circumstances, pronoun information may require confidential handling:
|
In certain circumstances, pronoun information may require confidential handling:
|
||||||
- **Safety Concerns**: Some individuals may face risk if their gender identity becomes widely known
|
- **Safety Concerns**: Some individuals may face risk if their gender identity becomes widely known
|
||||||
- **Professional Contexts**: Workplace or academic situations may require careful navigation
|
- **Professional Contexts**: Workplace or academic situations may require careful navigation
|
||||||
@@ -434,21 +434,21 @@ In certain circumstances, pronoun information may require confidential handling:
|
|||||||
|
|
||||||
## 6. Accessibility and Universal Design
|
## 6. Accessibility and Universal Design
|
||||||
|
|
||||||
### 6.1 Commitment to Accessibility
|
### 6.1. Commitment to Accessibility
|
||||||
|
|
||||||
#### 6.1.1 Foundational Principles
|
#### 6.1.1. Foundational Principles
|
||||||
Our community is committed to ensuring that all members, regardless of disability status or access needs, can participate fully and meaningfully in all community activities, discussions, and opportunities. This commitment reflects our core values of inclusion, equality, and universal respect for human dignity.
|
Our community is committed to ensuring that all members, regardless of disability status or access needs, can participate fully and meaningfully in all community activities, discussions, and opportunities. This commitment reflects our core values of inclusion, equality, and universal respect for human dignity.
|
||||||
|
|
||||||
#### 6.1.2 Universal Design Philosophy
|
#### 6.1.2. Universal Design Philosophy
|
||||||
We embrace universal design principles that recognise accessibility benefits extend beyond individuals with specific disabilities:
|
We embrace universal design principles that recognise accessibility benefits extend beyond individuals with specific disabilities:
|
||||||
- **Broader Benefits**: Accessible content is easier for everyone to consume and understand
|
- **Broader Benefits**: Accessible content is easier for everyone to consume and understand
|
||||||
- **Future-Proofing**: Accessible practices accommodate evolving technology and changing needs
|
- **Future-Proofing**: Accessible practices accommodate evolving technology and changing needs
|
||||||
- **Inclusive Culture**: Accessibility awareness creates more thoughtful, inclusive community culture
|
- **Inclusive Culture**: Accessibility awareness creates more thoughtful, inclusive community culture
|
||||||
- **Innovation Driver**: Accessibility requirements often lead to creative solutions that benefit all users
|
- **Innovation Driver**: Accessibility requirements often lead to creative solutions that benefit all users
|
||||||
|
|
||||||
### 6.2 Visual Content and Alternative Text
|
### 6.2. Visual Content and Alternative Text
|
||||||
|
|
||||||
#### 6.2.1 Alternative Text Requirements and Best Practices
|
#### 6.2.1. Alternative Text Requirements and Best Practices
|
||||||
All visual content shared within our community should include descriptive alternative text to ensure accessibility for screen reader users and individuals who cannot view images directly.
|
All visual content shared within our community should include descriptive alternative text to ensure accessibility for screen reader users and individuals who cannot view images directly.
|
||||||
|
|
||||||
**Comprehensive Alt Text Guidelines:**
|
**Comprehensive Alt Text Guidelines:**
|
||||||
@@ -472,15 +472,15 @@ All visual content shared within our community should include descriptive altern
|
|||||||
- Instead of: "meme" or "funny picture"
|
- Instead of: "meme" or "funny picture"
|
||||||
- Use: "A photograph of a golden retriever wearing sunglasses sitting at a computer desk, with text reading 'When you finally understand the assignment' in bold white letters"
|
- Use: "A photograph of a golden retriever wearing sunglasses sitting at a computer desk, with text reading 'When you finally understand the assignment' in bold white letters"
|
||||||
|
|
||||||
#### 6.2.2 Context-Appropriate Description
|
#### 6.2.2. Context-Appropriate Description
|
||||||
Effective alternative text considers:
|
Effective alternative text considers:
|
||||||
- **Audience Needs**: What information do viewers need to understand the content's purpose?
|
- **Audience Needs**: What information do viewers need to understand the content's purpose?
|
||||||
- **Context Relevance**: How does the image relate to the surrounding discussion or content?
|
- **Context Relevance**: How does the image relate to the surrounding discussion or content?
|
||||||
- **Essential Information**: Which visual elements are crucial for comprehension versus decorative?
|
- **Essential Information**: Which visual elements are crucial for comprehension versus decorative?
|
||||||
|
|
||||||
### 6.3 Content Structure and Navigation
|
### 6.3. Content Structure and Navigation
|
||||||
|
|
||||||
#### 6.3.1 Hierarchical Organisation
|
#### 6.3.1. Hierarchical Organisation
|
||||||
Well-structured content enhances accessibility and usability for all community members:
|
Well-structured content enhances accessibility and usability for all community members:
|
||||||
|
|
||||||
**Heading Structure:**
|
**Heading Structure:**
|
||||||
@@ -493,7 +493,7 @@ Well-structured content enhances accessibility and usability for all community m
|
|||||||
- Use bullet points, numbered lists, or other organisational tools for complex information
|
- Use bullet points, numbered lists, or other organisational tools for complex information
|
||||||
- Group related information together under appropriate headings
|
- Group related information together under appropriate headings
|
||||||
|
|
||||||
#### 6.3.2 Link and Navigation Standards
|
#### 6.3.2. Link and Navigation Standards
|
||||||
Accessible navigation requires:
|
Accessible navigation requires:
|
||||||
|
|
||||||
**Descriptive Link Text:**
|
**Descriptive Link Text:**
|
||||||
@@ -505,9 +505,9 @@ Accessible navigation requires:
|
|||||||
- Instead of: "Click here for more information"
|
- Instead of: "Click here for more information"
|
||||||
- Use: "View our upcoming community events and registration details"
|
- Use: "View our upcoming community events and registration details"
|
||||||
|
|
||||||
### 6.4 Multimedia Content Accessibility
|
### 6.4. Multimedia Content Accessibility
|
||||||
|
|
||||||
#### 6.4.1 Video Content Requirements
|
#### 6.4.1. Video Content Requirements
|
||||||
Video content shared within our community should include:
|
Video content shared within our community should include:
|
||||||
|
|
||||||
**Captions and Subtitles:**
|
**Captions and Subtitles:**
|
||||||
@@ -521,61 +521,61 @@ Video content shared within our community should include:
|
|||||||
- Description of actions, settings, facial expressions, and visual information
|
- Description of actions, settings, facial expressions, and visual information
|
||||||
- Integration that doesn't interfere with original audio content
|
- Integration that doesn't interfere with original audio content
|
||||||
|
|
||||||
#### 6.4.2 Audio Content Support
|
#### 6.4.2. Audio Content Support
|
||||||
Audio-only content benefits from:
|
Audio-only content benefits from:
|
||||||
- **Complete Transcripts**: Full text versions of audio content
|
- **Complete Transcripts**: Full text versions of audio content
|
||||||
- **Chapter Markers**: Time-stamped section indicators for easy navigation
|
- **Chapter Markers**: Time-stamped section indicators for easy navigation
|
||||||
- **Content Summaries**: Brief descriptions of audio content for quick reference
|
- **Content Summaries**: Brief descriptions of audio content for quick reference
|
||||||
|
|
||||||
### 6.5 Sensitive Content and Seizure Prevention
|
### 6.5. Sensitive Content and Seizure Prevention
|
||||||
|
|
||||||
#### 6.5.1 Flashing and Moving Content
|
#### 6.5.1. Flashing and Moving Content
|
||||||
To protect individuals with photosensitive epilepsy and other conditions:
|
To protect individuals with photosensitive epilepsy and other conditions:
|
||||||
- **Avoid Rapid Flashing**: Never share content that flashes more than three times per second
|
- **Avoid Rapid Flashing**: Never share content that flashes more than three times per second
|
||||||
- **Provide Warnings**: Include clear warnings before sharing potentially problematic content
|
- **Provide Warnings**: Include clear warnings before sharing potentially problematic content
|
||||||
- **Alternative Formats**: Offer still images or descriptions as alternatives when possible
|
- **Alternative Formats**: Offer still images or descriptions as alternatives when possible
|
||||||
|
|
||||||
#### 6.5.2 Content Warnings and Preparation
|
#### 6.5.2. Content Warnings and Preparation
|
||||||
Comprehensive content warnings help individuals prepare for or avoid potentially harmful content:
|
Comprehensive content warnings help individuals prepare for or avoid potentially harmful content:
|
||||||
- **Specific Descriptions**: Provide clear, specific information about content nature
|
- **Specific Descriptions**: Provide clear, specific information about content nature
|
||||||
- **Placement**: Position warnings before the potentially problematic content
|
- **Placement**: Position warnings before the potentially problematic content
|
||||||
- **Multiple Formats**: Use both text warnings and visual indicators when appropriate
|
- **Multiple Formats**: Use both text warnings and visual indicators when appropriate
|
||||||
|
|
||||||
### 6.6 Community Support and Continuous Improvement
|
### 6.6. Community Support and Continuous Improvement
|
||||||
|
|
||||||
#### 6.6.1 Feedback and Enhancement
|
#### 6.6.1. Feedback and Enhancement
|
||||||
Our commitment to accessibility includes:
|
Our commitment to accessibility includes:
|
||||||
- **Community Input**: Welcoming feedback on accessibility barriers and improvement opportunities
|
- **Community Input**: Welcoming feedback on accessibility barriers and improvement opportunities
|
||||||
- **Regular Assessment**: Periodic review of accessibility practices and their effectiveness
|
- **Regular Assessment**: Periodic review of accessibility practices and their effectiveness
|
||||||
- **Resource Sharing**: Providing tools, guides, and educational materials about accessibility
|
- **Resource Sharing**: Providing tools, guides, and educational materials about accessibility
|
||||||
- **Collaborative Improvement**: Working together to identify and address accessibility challenges
|
- **Collaborative Improvement**: Working together to identify and address accessibility challenges
|
||||||
|
|
||||||
#### 6.6.2 Education and Awareness
|
#### 6.6.2. Education and Awareness
|
||||||
Building accessibility awareness throughout our community involves:
|
Building accessibility awareness throughout our community involves:
|
||||||
- **Training Opportunities**: Offering education about disability awareness and inclusive practices
|
- **Training Opportunities**: Offering education about disability awareness and inclusive practices
|
||||||
- **Resource Development**: Creating guides and tools to support accessible content creation
|
- **Resource Development**: Creating guides and tools to support accessible content creation
|
||||||
- **Cultural Change**: Fostering community norms that prioritise accessibility and inclusion
|
- **Cultural Change**: Fostering community norms that prioritise accessibility and inclusion
|
||||||
- **Recognition Programs**: Celebrating community members who demonstrate exceptional commitment to accessibility
|
- **Recognition Programmes**: Celebrating community members who demonstrate exceptional commitment to accessibility
|
||||||
|
|
||||||
## 7. Content Warnings and Trauma-Informed Practices
|
## 7. Content Warnings and Trauma-Informed Practices
|
||||||
|
|
||||||
### 7.1 Trauma-Informed Community Approach
|
### 7.1. Trauma-Informed Community Approach
|
||||||
|
|
||||||
#### 7.1.1 Understanding Trauma Impact
|
#### 7.1.1. Understanding Trauma Impact
|
||||||
Our community recognises that many individuals have experienced various forms of trauma, and exposure to related content can cause significant distress, trigger harmful memories, or impact mental health. Content warnings represent our commitment to trauma-informed practices that prioritise community member safety and well-being.
|
Our community recognises that many individuals have experienced various forms of trauma, and exposure to related content can cause significant distress, trigger harmful memories, or impact mental health. Content warnings represent our commitment to trauma-informed practices that prioritise community member safety and well-being.
|
||||||
|
|
||||||
#### 7.1.2 Community Safety Framework
|
#### 7.1.2. Community Safety Framework
|
||||||
Content warnings contribute to community safety by:
|
Content warnings contribute to community safety by:
|
||||||
- **Informed Consent**: Enabling individuals to make educated decisions about content engagement
|
- **Informed Consent**: Enabling individuals to make educated decisions about content engagement
|
||||||
- **Risk Reduction**: Minimising unintentional exposure to potentially harmful content
|
- **Risk Reduction**: Minimising unintentional exposure to potentially harmful content
|
||||||
- **Control and Agency**: Providing individuals with control over their content consumption
|
- **Control and Agency**: Providing individuals with control over their content consumption
|
||||||
- **Inclusive Environment**: Creating spaces where trauma survivors can participate safely
|
- **Inclusive Environment**: Creating spaces where trauma survivors can participate safely
|
||||||
|
|
||||||
### 7.2 Content Warning Requirements Reference
|
### 7.2. Content Warning Requirements Reference
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive content warning requirements, including mandatory categories, enforcement procedures, and compliance standards, are set forth in our Content and Moderation Policy, which is incorporated herein by reference.**
|
**IMPORTANT: Comprehensive content warning requirements, including mandatory categories, enforcement procedures, and compliance standards, are set forth in our Content and Moderation Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
#### 7.2.1 Community-Specific Guidance
|
#### 7.2.1. Community-Specific Guidance
|
||||||
|
|
||||||
Content warnings are **mandatory** across all community spaces. Key community-specific considerations include:
|
Content warnings are **mandatory** across all community spaces. Key community-specific considerations include:
|
||||||
|
|
||||||
@@ -583,9 +583,9 @@ Content warnings are **mandatory** across all community spaces. Key community-sp
|
|||||||
- **Community Context**: Apply content warning standards thoughtfully within the context of community discussions and interactions
|
- **Community Context**: Apply content warning standards thoughtfully within the context of community discussions and interactions
|
||||||
- **Educational Support**: Community members are encouraged to support one another in learning and applying content warning practices
|
- **Educational Support**: Community members are encouraged to support one another in learning and applying content warning practices
|
||||||
|
|
||||||
### 7.4 Effective Warning Implementation
|
### 7.4. Effective Warning Implementation
|
||||||
|
|
||||||
#### 7.4.1 Warning Format and Placement
|
#### 7.4.1. Warning Format and Placement
|
||||||
Effective content warnings should:
|
Effective content warnings should:
|
||||||
|
|
||||||
**Placement and Visibility:**
|
**Placement and Visibility:**
|
||||||
@@ -603,33 +603,33 @@ Effective content warnings should:
|
|||||||
- "CW: Graphic descriptions of physical violence"
|
- "CW: Graphic descriptions of physical violence"
|
||||||
- "Trigger Warning: References to sexual assault and trauma recovery"
|
- "Trigger Warning: References to sexual assault and trauma recovery"
|
||||||
|
|
||||||
#### 7.4.2 Spoiler Tags and Content Hiding
|
#### 7.4.2. Spoiler Tags and Content Hiding
|
||||||
When platform features allow:
|
When platform features allow:
|
||||||
- Use spoiler tags, content hiding, or "read more" cuts to conceal potentially triggering content
|
- Use spoiler tags, content hiding, or "read more" cuts to conceal potentially triggering content
|
||||||
- Combine warnings with hiding mechanisms for maximum protection
|
- Combine warnings with hiding mechanisms for maximum protection
|
||||||
- Ensure warnings remain visible even when content is hidden
|
- Ensure warnings remain visible even when content is hidden
|
||||||
|
|
||||||
### 7.5 Community Response and Support
|
### 7.5. Community Response and Support
|
||||||
|
|
||||||
#### 7.5.1 Respectful Responses to Warnings
|
#### 7.5.1. Respectful Responses to Warnings
|
||||||
Community members should demonstrate respect for content warning practices by:
|
Community members should demonstrate respect for content warning practices by:
|
||||||
- **Taking Warnings Seriously**: Never mock, dismiss, or minimise the importance of content warnings
|
- **Taking Warnings Seriously**: Never mock, dismiss, or minimise the importance of content warnings
|
||||||
- **Individual Needs Recognition**: Understanding that warning needs vary among individuals
|
- **Individual Needs Recognition**: Understanding that warning needs vary among individuals
|
||||||
- **Gracious Compliance**: Accepting requests for additional warnings without defensiveness
|
- **Gracious Compliance**: Accepting requests for additional warnings without defensiveness
|
||||||
- **Supportive Behaviour**: Encouraging and normalising content warning usage
|
- **Supportive Behaviour**: Encouraging and normalising content warning usage
|
||||||
|
|
||||||
#### 7.5.2 Appropriate Challenge and Discussion
|
#### 7.5.2. Appropriate Challenge and Discussion
|
||||||
While respecting content warnings, community members may:
|
While respecting content warnings, community members may:
|
||||||
- **Request Clarification**: Ask for more specific warnings when needed
|
- **Request Clarification**: Ask for more specific warnings when needed
|
||||||
- **Suggest Improvements**: Offer constructive feedback about warning effectiveness
|
- **Suggest Improvements**: Offer constructive feedback about warning effectiveness
|
||||||
- **Share Resources**: Provide educational materials about trauma-informed practices
|
- **Share Resources**: Provide educational materials about trauma-informed practices
|
||||||
- **Model Best Practices**: Demonstrate excellent content warning usage for others to follow
|
- **Model Best Practices**: Demonstrate excellent content warning usage for others to follow
|
||||||
|
|
||||||
### 7.6 Enforcement Reference
|
### 7.6. Enforcement Reference
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive enforcement procedures for content warning violations, including response protocols, disciplinary measures, and appeals processes, are set forth in our Content and Moderation Policy, which is incorporated herein by reference.**
|
**IMPORTANT: Comprehensive enforcement procedures for content warning violations, including response protocols, disciplinary measures, and appeals processes, are set forth in our Content and Moderation Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
#### 7.6.1 Community Education and Support
|
#### 7.6.1. Community Education and Support
|
||||||
Our community commitment to content warning compliance includes:
|
Our community commitment to content warning compliance includes:
|
||||||
- **Peer Support**: Community members helping one another learn and apply content warning practices
|
- **Peer Support**: Community members helping one another learn and apply content warning practices
|
||||||
- **Educational Approach**: Emphasis on learning and improvement rather than punishment when possible
|
- **Educational Approach**: Emphasis on learning and improvement rather than punishment when possible
|
||||||
@@ -637,12 +637,12 @@ Our community commitment to content warning compliance includes:
|
|||||||
|
|
||||||
## 8. Conflict Resolution and Mediation
|
## 8. Conflict Resolution and Mediation
|
||||||
|
|
||||||
### 8.1 Philosophy of Constructive Conflict Management
|
### 8.1. Philosophy of Constructive Conflict Management
|
||||||
|
|
||||||
#### 8.1.1 Conflict as Natural Community Element
|
#### 8.1.1. Conflict as Natural Community Element
|
||||||
Conflicts, disagreements, and differences of opinion represent natural and inevitable aspects of any vibrant, diverse community. Rather than viewing conflict as inherently negative or destructive, our community approaches disagreements as opportunities for growth, learning, and strengthened relationships when handled constructively.
|
Conflicts, disagreements, and differences of opinion represent natural and inevitable aspects of any vibrant, diverse community. Rather than viewing conflict as inherently negative or destructive, our community approaches disagreements as opportunities for growth, learning, and strengthened relationships when handled constructively.
|
||||||
|
|
||||||
#### 8.1.2 Restorative Justice Principles
|
#### 8.1.2. Restorative Justice Principles
|
||||||
Our conflict resolution approach emphasises:
|
Our conflict resolution approach emphasises:
|
||||||
- **Relationship Repair**: Focus on healing and strengthening community relationships
|
- **Relationship Repair**: Focus on healing and strengthening community relationships
|
||||||
- **Mutual Understanding**: Encouraging empathy and perspective-taking among conflicting parties
|
- **Mutual Understanding**: Encouraging empathy and perspective-taking among conflicting parties
|
||||||
@@ -650,9 +650,9 @@ Our conflict resolution approach emphasises:
|
|||||||
- **Collaborative Solutions**: Seeking win-win outcomes that address underlying needs and concerns
|
- **Collaborative Solutions**: Seeking win-win outcomes that address underlying needs and concerns
|
||||||
- **Community Strengthening**: Leveraging conflict resolution to build more resilient community bonds
|
- **Community Strengthening**: Leveraging conflict resolution to build more resilient community bonds
|
||||||
|
|
||||||
### 8.2 Foundational Principles for Constructive Engagement
|
### 8.2. Foundational Principles for Constructive Engagement
|
||||||
|
|
||||||
#### 8.2.1 Core Engagement Standards
|
#### 8.2.1. Core Engagement Standards
|
||||||
All community members engaged in conflict resolution should demonstrate:
|
All community members engaged in conflict resolution should demonstrate:
|
||||||
|
|
||||||
**Respect and Human Dignity:**
|
**Respect and Human Dignity:**
|
||||||
@@ -671,11 +671,11 @@ All community members engaged in conflict resolution should demonstrate:
|
|||||||
- Address specific behaviours, actions, or policies rather than personal character attacks
|
- Address specific behaviours, actions, or policies rather than personal character attacks
|
||||||
- Concentrate on issues within the scope of community standards and values
|
- Concentrate on issues within the scope of community standards and values
|
||||||
- Offer constructive suggestions and alternative approaches when raising concerns
|
- Offer constructive suggestions and alternative approaches when raising concerns
|
||||||
- Avoid inflammatory language, generalizations, or escalatory rhetoric
|
- Avoid inflammatory language, generalisations, or escalatory rhetoric
|
||||||
|
|
||||||
### 8.3 Self-Directed Resolution Process
|
### 8.3. Self-Directed Resolution Process
|
||||||
|
|
||||||
#### 8.3.1 Direct Communication Framework
|
#### 8.3.1. Direct Communication Framework
|
||||||
The preferred first step in conflict resolution involves direct communication between affected parties:
|
The preferred first step in conflict resolution involves direct communication between affected parties:
|
||||||
|
|
||||||
**Preparation Phase:**
|
**Preparation Phase:**
|
||||||
@@ -695,7 +695,7 @@ The preferred first step in conflict resolution involves direct communication be
|
|||||||
- "I understand you might have intended [acknowledged intent], but the impact was [specific effect]"
|
- "I understand you might have intended [acknowledged intent], but the impact was [specific effect]"
|
||||||
- "I would appreciate if we could [specific request for change] in future interactions"
|
- "I would appreciate if we could [specific request for change] in future interactions"
|
||||||
|
|
||||||
#### 8.3.2 Cooling-Down Period Management
|
#### 8.3.2. Cooling-Down Period Management
|
||||||
When emotions run high or productive communication becomes difficult:
|
When emotions run high or productive communication becomes difficult:
|
||||||
|
|
||||||
**Recognition Signs:**
|
**Recognition Signs:**
|
||||||
@@ -710,9 +710,9 @@ When emotions run high or productive communication becomes difficult:
|
|||||||
- **Perspective-Taking**: Consider the situation from other parties' viewpoints during the pause
|
- **Perspective-Taking**: Consider the situation from other parties' viewpoints during the pause
|
||||||
- **Solution Focus**: Return to discussions with renewed focus on collaborative problem-solving
|
- **Solution Focus**: Return to discussions with renewed focus on collaborative problem-solving
|
||||||
|
|
||||||
### 8.4 Community-Supported Mediation
|
### 8.4. Community-Supported Mediation
|
||||||
|
|
||||||
#### 8.4.1 Third-Party Mediation Process
|
#### 8.4.1. Third-Party Mediation Process
|
||||||
When direct communication fails to resolve conflicts, community-supported mediation offers structured assistance:
|
When direct communication fails to resolve conflicts, community-supported mediation offers structured assistance:
|
||||||
|
|
||||||
**Mediator Selection:**
|
**Mediator Selection:**
|
||||||
@@ -728,7 +728,7 @@ When direct communication fails to resolve conflicts, community-supported mediat
|
|||||||
- **Solution Development**: Collaborative generation of potential solutions
|
- **Solution Development**: Collaborative generation of potential solutions
|
||||||
- **Agreement Formation**: Development of specific, actionable resolution agreements
|
- **Agreement Formation**: Development of specific, actionable resolution agreements
|
||||||
|
|
||||||
#### 8.4.2 Mediator Responsibilities and Guidelines
|
#### 8.4.2. Mediator Responsibilities and Guidelines
|
||||||
Community members serving as mediators should:
|
Community members serving as mediators should:
|
||||||
- **Maintain Neutrality**: Avoid taking sides or advocating for specific outcomes
|
- **Maintain Neutrality**: Avoid taking sides or advocating for specific outcomes
|
||||||
- **Facilitate Communication**: Help parties express themselves clearly and listen effectively
|
- **Facilitate Communication**: Help parties express themselves clearly and listen effectively
|
||||||
@@ -736,9 +736,9 @@ Community members serving as mediators should:
|
|||||||
- **Focus on Solutions**: Guide discussions toward constructive problem-solving
|
- **Focus on Solutions**: Guide discussions toward constructive problem-solving
|
||||||
- **Respect Confidentiality**: Maintain privacy about mediation discussions unless agreed otherwise
|
- **Respect Confidentiality**: Maintain privacy about mediation discussions unless agreed otherwise
|
||||||
|
|
||||||
### 8.5 Staff Intervention and Escalation
|
### 8.5. Staff Intervention and Escalation
|
||||||
|
|
||||||
#### 8.5.1 Appropriate Escalation Triggers
|
#### 8.5.1. Appropriate Escalation Triggers
|
||||||
Community members should involve staff moderators when conflicts involve:
|
Community members should involve staff moderators when conflicts involve:
|
||||||
|
|
||||||
**Safety and Harassment Concerns:**
|
**Safety and Harassment Concerns:**
|
||||||
@@ -759,7 +759,7 @@ Community members should involve staff moderators when conflicts involve:
|
|||||||
- Situations where parties refuse to engage constructively in resolution attempts
|
- Situations where parties refuse to engage constructively in resolution attempts
|
||||||
- Complex issues requiring specialised knowledge or authority to resolve
|
- Complex issues requiring specialised knowledge or authority to resolve
|
||||||
|
|
||||||
#### 8.5.2 Staff Intervention Protocols
|
#### 8.5.2. Staff Intervention Protocols
|
||||||
When staff intervention becomes necessary:
|
When staff intervention becomes necessary:
|
||||||
|
|
||||||
**Assessment and Planning:**
|
**Assessment and Planning:**
|
||||||
@@ -774,15 +774,15 @@ When staff intervention becomes necessary:
|
|||||||
- **Stakeholder Communication**: Clear, respectful communication with all involved parties
|
- **Stakeholder Communication**: Clear, respectful communication with all involved parties
|
||||||
- **Solution Development**: Collaborative development of sustainable, fair resolution approaches
|
- **Solution Development**: Collaborative development of sustainable, fair resolution approaches
|
||||||
|
|
||||||
### 8.6 Appeal and Review Processes
|
### 8.6. Appeal and Review Processes
|
||||||
|
|
||||||
#### 8.6.1 Dispute Resolution Appeals Reference
|
#### 8.6.1. Dispute Resolution Appeals Reference
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive appeals procedures, including appeal grounds, submission processes, and review standards, are set forth in our dedicated [Appeals Process](/community/appeal) document.**
|
**IMPORTANT: Comprehensive appeals procedures, including appeal grounds, submission processes, and review standards, are set forth in our dedicated [Appeals Process](/community/appeal) document.**
|
||||||
|
|
||||||
Community members who disagree with conflict resolution outcomes may access our formal appeals process, which provides independent review of procedural concerns, new evidence, and resolution appropriateness.
|
Community members who disagree with conflict resolution outcomes may access our formal appeals process, which provides independent review of procedural concerns, new evidence, and resolution appropriateness.
|
||||||
|
|
||||||
#### 8.6.2 Learning and Improvement Integration
|
#### 8.6.2. Learning and Improvement Integration
|
||||||
Our conflict resolution system includes mechanisms for continuous improvement:
|
Our conflict resolution system includes mechanisms for continuous improvement:
|
||||||
- **Process Evaluation**: Regular assessment of resolution effectiveness and fairness
|
- **Process Evaluation**: Regular assessment of resolution effectiveness and fairness
|
||||||
- **Community Feedback**: Collection of input from parties who have used resolution processes
|
- **Community Feedback**: Collection of input from parties who have used resolution processes
|
||||||
@@ -791,12 +791,12 @@ Our conflict resolution system includes mechanisms for continuous improvement:
|
|||||||
|
|
||||||
## 9. Community Enjoyment and Well-being
|
## 9. Community Enjoyment and Well-being
|
||||||
|
|
||||||
### 9.1 Fundamental Philosophy: Community as Enjoyable Experience
|
### 9.1. Fundamental Philosophy: Community as Enjoyable Experience
|
||||||
|
|
||||||
#### 9.1.1 Central Principle
|
#### 9.1.1. Central Principle
|
||||||
Participation in our community should fundamentally be an enjoyable, fulfilling, and positive experience for all members. This principle underlies all other community policies, guidelines, and practices, serving as the ultimate measure of our community's success and health.
|
Participation in our community should fundamentally be an enjoyable, fulfilling, and positive experience for all members. This principle underlies all other community policies, guidelines, and practices, serving as the ultimate measure of our community's success and health.
|
||||||
|
|
||||||
#### 9.1.2 Signs of Healthy Community Engagement
|
#### 9.1.2. Signs of Healthy Community Engagement
|
||||||
Community members who are having positive experiences typically demonstrate:
|
Community members who are having positive experiences typically demonstrate:
|
||||||
- **Enthusiasm**: Genuine excitement about participating in discussions and activities
|
- **Enthusiasm**: Genuine excitement about participating in discussions and activities
|
||||||
- **Curiosity**: Interest in learning from others and exploring new ideas or perspectives
|
- **Curiosity**: Interest in learning from others and exploring new ideas or perspectives
|
||||||
@@ -804,9 +804,9 @@ Community members who are having positive experiences typically demonstrate:
|
|||||||
- **Relaxation**: Ability to engage naturally without excessive stress or anxiety about community interactions
|
- **Relaxation**: Ability to engage naturally without excessive stress or anxiety about community interactions
|
||||||
- **Growth**: Development of new skills, knowledge, or relationships through community participation
|
- **Growth**: Development of new skills, knowledge, or relationships through community participation
|
||||||
|
|
||||||
### 9.2 Self-Care and Boundary Management
|
### 9.2. Self-Care and Boundary Management
|
||||||
|
|
||||||
#### 9.2.1 Recognising the Need for Breaks
|
#### 9.2.1. Recognising the Need for Breaks
|
||||||
Community members are encouraged to recognise when they need distance from community activities:
|
Community members are encouraged to recognise when they need distance from community activities:
|
||||||
|
|
||||||
**Warning Signs for Break Consideration:**
|
**Warning Signs for Break Consideration:**
|
||||||
@@ -816,7 +816,7 @@ Community members are encouraged to recognise when they need distance from commu
|
|||||||
- Losing interest in previously enjoyable community activities or discussions
|
- Losing interest in previously enjoyable community activities or discussions
|
||||||
- Noticing that community participation negatively impacts other areas of life
|
- Noticing that community participation negatively impacts other areas of life
|
||||||
|
|
||||||
#### 9.2.2 Taking Healthy Breaks
|
#### 9.2.2. Taking Healthy Breaks
|
||||||
When breaks become necessary:
|
When breaks become necessary:
|
||||||
|
|
||||||
**Permission and Encouragement:**
|
**Permission and Encouragement:**
|
||||||
@@ -831,16 +831,16 @@ When breaks become necessary:
|
|||||||
- **Read-Only Mode**: Consuming community content without feeling pressure to contribute actively
|
- **Read-Only Mode**: Consuming community content without feeling pressure to contribute actively
|
||||||
- **Selective Participation**: Engaging only with specific community areas or topics that remain enjoyable
|
- **Selective Participation**: Engaging only with specific community areas or topics that remain enjoyable
|
||||||
|
|
||||||
#### 9.2.3 Return and Re-engagement
|
#### 9.2.3. Return and Re-engagement
|
||||||
When community members feel ready to return:
|
When community members feel ready to return:
|
||||||
- **Gradual Re-engagement**: No pressure to immediately return to previous participation levels
|
- **Gradual Re-engagement**: No pressure to immediately return to previous participation levels
|
||||||
- **Continued Boundary Management**: Ongoing permission to adjust participation as needed
|
- **Continued Boundary Management**: Ongoing permission to adjust participation as needed
|
||||||
- **Community Support**: Assistance from other members in finding comfortable re-engagement approaches
|
- **Community Support**: Assistance from other members in finding comfortable re-engagement approaches
|
||||||
- **Learning Integration**: Application of insights gained during breaks to enhance future community experience
|
- **Learning Integration**: Application of insights gained during breaks to enhance future community experience
|
||||||
|
|
||||||
### 9.3 Engagement Style Assessment and Adjustment
|
### 9.3. Engagement Style Assessment and Adjustment
|
||||||
|
|
||||||
#### 9.3.1 Self-Reflection on Interaction Patterns
|
#### 9.3.1. Self-Reflection on Interaction Patterns
|
||||||
Community members experiencing consistent dissatisfaction should consider:
|
Community members experiencing consistent dissatisfaction should consider:
|
||||||
|
|
||||||
**Interaction Style Evaluation:**
|
**Interaction Style Evaluation:**
|
||||||
@@ -855,7 +855,7 @@ Community members experiencing consistent dissatisfaction should consider:
|
|||||||
- Are your expectations for community interaction realistic and appropriate?
|
- Are your expectations for community interaction realistic and appropriate?
|
||||||
- Do you find meaning and satisfaction in the types of activities and discussions the community offers?
|
- Do you find meaning and satisfaction in the types of activities and discussions the community offers?
|
||||||
|
|
||||||
#### 9.3.2 Adjustment and Improvement Strategies
|
#### 9.3.2. Adjustment and Improvement Strategies
|
||||||
When reflection reveals opportunities for improvement:
|
When reflection reveals opportunities for improvement:
|
||||||
|
|
||||||
**Communication Style Modifications:**
|
**Communication Style Modifications:**
|
||||||
@@ -870,9 +870,9 @@ When reflection reveals opportunities for improvement:
|
|||||||
- Appreciate the volunteer nature of community leadership and support systems
|
- Appreciate the volunteer nature of community leadership and support systems
|
||||||
- Celebrate small positive interactions rather than expecting dramatic community changes
|
- Celebrate small positive interactions rather than expecting dramatic community changes
|
||||||
|
|
||||||
### 9.4 Staff-Supported Temporary Restrictions
|
### 9.4. Staff-Supported Temporary Restrictions
|
||||||
|
|
||||||
#### 9.4.1 Voluntary Temporary Exclusion
|
#### 9.4.1. Voluntary Temporary Exclusion
|
||||||
For community members who struggle with self-regulated breaks, our staff team offers supportive temporary restrictions:
|
For community members who struggle with self-regulated breaks, our staff team offers supportive temporary restrictions:
|
||||||
|
|
||||||
**Service Description:**
|
**Service Description:**
|
||||||
@@ -887,7 +887,7 @@ For community members who struggle with self-regulated breaks, our staff team of
|
|||||||
- Need for external structure to support personal well-being goals
|
- Need for external structure to support personal well-being goals
|
||||||
- Temporary life circumstances that require reduced digital engagement
|
- Temporary life circumstances that require reduced digital engagement
|
||||||
|
|
||||||
#### 9.4.2 Request Process and Implementation
|
#### 9.4.2. Request Process and Implementation
|
||||||
Members seeking voluntary temporary restrictions can:
|
Members seeking voluntary temporary restrictions can:
|
||||||
|
|
||||||
**Request Procedure:**
|
**Request Procedure:**
|
||||||
@@ -902,9 +902,9 @@ Members seeking voluntary temporary restrictions can:
|
|||||||
- Check-in communications at agreed intervals to assess continued need
|
- Check-in communications at agreed intervals to assess continued need
|
||||||
- Collaborative planning for gradual re-engagement when restrictions end
|
- Collaborative planning for gradual re-engagement when restrictions end
|
||||||
|
|
||||||
### 9.5 Community Culture and Atmosphere Maintenance
|
### 9.5. Community Culture and Atmosphere Maintenance
|
||||||
|
|
||||||
#### 9.5.1 Collective Responsibility for Positive Environment
|
#### 9.5.1. Collective Responsibility for Positive Environment
|
||||||
Creating and maintaining an enjoyable community experience requires collective effort from all members:
|
Creating and maintaining an enjoyable community experience requires collective effort from all members:
|
||||||
|
|
||||||
**Individual Contributions:**
|
**Individual Contributions:**
|
||||||
@@ -920,7 +920,7 @@ Creating and maintaining an enjoyable community experience requires collective e
|
|||||||
- Constructive handling of challenges and conflicts that arise
|
- Constructive handling of challenges and conflicts that arise
|
||||||
- Ongoing evolution of community practices to better serve member needs
|
- Ongoing evolution of community practices to better serve member needs
|
||||||
|
|
||||||
#### 9.5.2 Identifying and Addressing Systemic Issues
|
#### 9.5.2. Identifying and Addressing Systemic Issues
|
||||||
When community enjoyment becomes consistently problematic:
|
When community enjoyment becomes consistently problematic:
|
||||||
|
|
||||||
**Issue Recognition:**
|
**Issue Recognition:**
|
||||||
@@ -937,17 +937,17 @@ When community enjoyment becomes consistently problematic:
|
|||||||
|
|
||||||
## 10. Mini-Moderation and Peer Support
|
## 10. Mini-Moderation and Peer Support
|
||||||
|
|
||||||
### 10.1 Understanding Mini-Moderation
|
### 10.1. Understanding Mini-Moderation
|
||||||
|
|
||||||
#### 10.1.1 Definition and Scope
|
#### 10.1.1. Definition and Scope
|
||||||
"Mini-moderation" refers to activities where non-staff community members provide guidance, correction, or support to other members regarding community standards, practices, or norms. This behaviour occupies a middle ground between passive observation and formal moderation authority.
|
"Mini-moderation" refers to activities where non-staff community members provide guidance, correction, or support to other members regarding community standards, practices, or norms. This behaviour occupies a middle ground between passive observation and formal moderation authority.
|
||||||
|
|
||||||
#### 10.1.2 Community Position on Mini-Moderation
|
#### 10.1.2. Community Position on Mini-Moderation
|
||||||
Our community adopts a permissive approach to mini-moderation, recognising its value in creating self-regulating, mutually supportive community environments. However, this permission comes with specific guidelines and limitations to prevent abuse or overreach.
|
Our community adopts a permissive approach to mini-moderation, recognising its value in creating self-regulating, mutually supportive community environments. However, this permission comes with specific guidelines and limitations to prevent abuse or overreach.
|
||||||
|
|
||||||
### 10.2 Acceptable Mini-Moderation Practices
|
### 10.2. Acceptable Mini-Moderation Practices
|
||||||
|
|
||||||
#### 10.2.1 Constructive Guidance and Support
|
#### 10.2.1. Constructive Guidance and Support
|
||||||
Appropriate mini-moderation includes:
|
Appropriate mini-moderation includes:
|
||||||
|
|
||||||
**Welcoming and Integration Support:**
|
**Welcoming and Integration Support:**
|
||||||
@@ -968,7 +968,7 @@ Appropriate mini-moderation includes:
|
|||||||
- Offering constructive feedback on content or communication style
|
- Offering constructive feedback on content or communication style
|
||||||
- Sharing resources that help community members understand expectations
|
- Sharing resources that help community members understand expectations
|
||||||
|
|
||||||
#### 10.2.2 Appropriate Communication Methods
|
#### 10.2.2. Appropriate Communication Methods
|
||||||
Effective mini-moderation employs:
|
Effective mini-moderation employs:
|
||||||
|
|
||||||
**Respectful Language and Tone:**
|
**Respectful Language and Tone:**
|
||||||
@@ -983,9 +983,9 @@ Effective mini-moderation employs:
|
|||||||
- Encourage questions and discussion rather than demanding compliance
|
- Encourage questions and discussion rather than demanding compliance
|
||||||
- Focus on community benefit rather than personal authority
|
- Focus on community benefit rather than personal authority
|
||||||
|
|
||||||
### 10.3 Prohibited Mini-Moderation Behaviours
|
### 10.3. Prohibited Mini-Moderation Behaviours
|
||||||
|
|
||||||
#### 10.3.1 Authority Misrepresentation
|
#### 10.3.1. Authority Misrepresentation
|
||||||
Community members engaged in mini-moderation must never:
|
Community members engaged in mini-moderation must never:
|
||||||
|
|
||||||
**False Authority Claims:**
|
**False Authority Claims:**
|
||||||
@@ -1000,7 +1000,7 @@ Community members engaged in mini-moderation must never:
|
|||||||
- Claim to speak on behalf of the community leadership
|
- Claim to speak on behalf of the community leadership
|
||||||
- Misrepresent the scope or nature of their community role
|
- Misrepresent the scope or nature of their community role
|
||||||
|
|
||||||
#### 10.3.2 Harmful or Counterproductive Approaches
|
#### 10.3.2. Harmful or Counterproductive Approaches
|
||||||
Inappropriate mini-moderation includes:
|
Inappropriate mini-moderation includes:
|
||||||
|
|
||||||
**Public Confrontation and Embarrassment:**
|
**Public Confrontation and Embarrassment:**
|
||||||
@@ -1015,9 +1015,9 @@ Inappropriate mini-moderation includes:
|
|||||||
- Escalating situations through argumentative or confrontational responses
|
- Escalating situations through argumentative or confrontational responses
|
||||||
- Demonstrating impatience or frustration with members who are learning
|
- Demonstrating impatience or frustration with members who are learning
|
||||||
|
|
||||||
### 10.4 Effective Mini-Moderation Strategies
|
### 10.4. Effective Mini-Moderation Strategies
|
||||||
|
|
||||||
#### 10.4.1 Leading by Example
|
#### 10.4.1. Leading by Example
|
||||||
The most effective mini-moderation approach involves:
|
The most effective mini-moderation approach involves:
|
||||||
|
|
||||||
**Consistent Positive Behaviour:**
|
**Consistent Positive Behaviour:**
|
||||||
@@ -1032,7 +1032,7 @@ The most effective mini-moderation approach involves:
|
|||||||
- Create welcoming environments for newcomers and less experienced participants
|
- Create welcoming environments for newcomers and less experienced participants
|
||||||
- Celebrate community successes and positive developments
|
- Celebrate community successes and positive developments
|
||||||
|
|
||||||
#### 10.4.2 Supportive Intervention Techniques
|
#### 10.4.2. Supportive Intervention Techniques
|
||||||
When mini-moderation becomes necessary:
|
When mini-moderation becomes necessary:
|
||||||
|
|
||||||
**Private Communication:**
|
**Private Communication:**
|
||||||
@@ -1047,9 +1047,9 @@ When mini-moderation becomes necessary:
|
|||||||
- Ask clarifying questions that encourage reflection rather than making direct accusations
|
- Ask clarifying questions that encourage reflection rather than making direct accusations
|
||||||
- Provide positive alternatives that naturally guide discussions in better directions
|
- Provide positive alternatives that naturally guide discussions in better directions
|
||||||
|
|
||||||
### 10.5 Escalation and Staff Involvement
|
### 10.5. Escalation and Staff Involvement
|
||||||
|
|
||||||
#### 10.5.1 Recognising Limits of Mini-Moderation
|
#### 10.5.1. Recognising Limits of Mini-Moderation
|
||||||
Community members should recognise when situations require professional staff intervention:
|
Community members should recognise when situations require professional staff intervention:
|
||||||
|
|
||||||
**Escalation Triggers:**
|
**Escalation Triggers:**
|
||||||
@@ -1059,7 +1059,7 @@ Community members should recognise when situations require professional staff in
|
|||||||
- Complex conflicts that require formal mediation or resolution processes
|
- Complex conflicts that require formal mediation or resolution processes
|
||||||
- Issues beyond the scope of peer education and support
|
- Issues beyond the scope of peer education and support
|
||||||
|
|
||||||
#### 10.5.2 Appropriate Escalation Procedures
|
#### 10.5.2. Appropriate Escalation Procedures
|
||||||
When mini-moderation reaches its limits:
|
When mini-moderation reaches its limits:
|
||||||
|
|
||||||
**Discontinue Personal Intervention:**
|
**Discontinue Personal Intervention:**
|
||||||
@@ -1074,9 +1074,9 @@ When mini-moderation reaches its limits:
|
|||||||
- Offer to provide additional information or context if staff request it
|
- Offer to provide additional information or context if staff request it
|
||||||
- Trust staff to handle situations according to their training and authority
|
- Trust staff to handle situations according to their training and authority
|
||||||
|
|
||||||
### 10.6 Community Benefits and Culture Building
|
### 10.6. Community Benefits and Culture Building
|
||||||
|
|
||||||
#### 10.6.1 Positive Impact of Effective Mini-Moderation
|
#### 10.6.1. Positive Impact of Effective Mini-Moderation
|
||||||
When conducted appropriately, mini-moderation contributes to:
|
When conducted appropriately, mini-moderation contributes to:
|
||||||
|
|
||||||
**Self-Regulating Community Culture:**
|
**Self-Regulating Community Culture:**
|
||||||
@@ -1091,7 +1091,7 @@ When conducted appropriately, mini-moderation contributes to:
|
|||||||
- Continuous improvement in community knowledge and practices
|
- Continuous improvement in community knowledge and practices
|
||||||
- Stronger relationships between community members
|
- Stronger relationships between community members
|
||||||
|
|
||||||
#### 10.6.2 Cultural Reinforcement and Development
|
#### 10.6.2. Cultural Reinforcement and Development
|
||||||
Effective mini-moderation helps establish:
|
Effective mini-moderation helps establish:
|
||||||
- **Norm Reinforcement**: Clear, consistent messaging about community expectations
|
- **Norm Reinforcement**: Clear, consistent messaging about community expectations
|
||||||
- **Inclusive Practices**: Support for members learning to participate effectively
|
- **Inclusive Practices**: Support for members learning to participate effectively
|
||||||
@@ -1108,4 +1108,4 @@ Our community's strength lies not in rigid rule enforcement, but in the voluntar
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*These Community Guidelines were last updated on 15 September 2025 and represent the collective wisdom and values of our community. For questions about these guidelines or suggestions for improvement, please contact our community staff through the designated channels outlined in our Community Code of Conduct.*
|
*These Community Guidelines represent the collective wisdom and values of our community. For questions about these guidelines or suggestions for improvement, please contact our community staff through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ title: Community Leadership and Governance Policy
|
|||||||
|
|
||||||
## 1. Foundation and Purpose
|
## 1. Foundation and Purpose
|
||||||
|
|
||||||
### 1.1 Introduction
|
### 1.1. Introduction
|
||||||
|
|
||||||
This Community Leadership and Governance Policy (hereinafter referred to as "the Policy") establishes the framework for transparent, accountable, and effective leadership within our community ecosystem. This Policy ensures that community leadership operates with integrity, serves the best interests of all community members, and maintains the highest standards of conduct whilst fostering a safe, welcoming, and inclusive environment.
|
This Community Leadership and Governance Policy (hereinafter referred to as "the Policy") establishes the framework for transparent, accountable, and effective leadership within our community ecosystem. This Policy ensures that community leadership operates with integrity, serves the best interests of all community members, and maintains the highest standards of conduct whilst fostering a safe, welcoming, and inclusive environment.
|
||||||
|
|
||||||
### 1.2 Core Principles
|
### 1.2. Core Principles
|
||||||
|
|
||||||
Our community leadership operates on the following foundational principles:
|
Our community leadership operates on the following foundational principles:
|
||||||
|
|
||||||
@@ -22,30 +22,30 @@ Our community leadership operates on the following foundational principles:
|
|||||||
|
|
||||||
**(e)** **Collaborative Governance**: Community input is actively sought and valued in decision-making processes.
|
**(e)** **Collaborative Governance**: Community input is actively sought and valued in decision-making processes.
|
||||||
|
|
||||||
### 1.3 Legal Framework Integration
|
### 1.3. Legal Framework Integration
|
||||||
|
|
||||||
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Community Code of Conduct, Content and Moderation Policy, and Limitation of Liability and Indemnification Policy, all of which are incorporated herein by reference.
|
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Community Code of Conduct, Content and Moderation Policy, and Limitation of Liability and Indemnification Policy, all of which are incorporated herein by reference.
|
||||||
|
|
||||||
## 2. Leadership Structure and Roles
|
## 2. Leadership Structure and Roles
|
||||||
|
|
||||||
### 2.1 Leadership Hierarchy
|
### 2.1. Leadership Hierarchy
|
||||||
|
|
||||||
Our community leadership operates through a structured hierarchy designed to ensure effective governance whilst maintaining accessibility and accountability:
|
Our community leadership operates through a structured hierarchy designed to ensure effective governance whilst maintaining accessibility and accountability:
|
||||||
|
|
||||||
#### 2.1.1 Executive Leadership
|
#### 2.1.1. Executive Leadership
|
||||||
|
|
||||||
- **Community Director**: Overall strategic direction and final decision-making authority
|
- **Community Director**: Overall strategic direction and final decision-making authority
|
||||||
- **Deputy Director**: Support for Community Director and succession planning
|
- **Deputy Director**: Support for Community Director and succession planning
|
||||||
- **Legal and Policy Advisor**: Oversight of legal compliance and policy development
|
- **Legal and Policy Advisor**: Oversight of legal compliance and policy development
|
||||||
|
|
||||||
#### 2.1.2 Operational Leadership
|
#### 2.1.2. Operational Leadership
|
||||||
|
|
||||||
- **Head Moderator**: Oversight of moderation team and enforcement consistency
|
- **Head Moderator**: Oversight of moderation team and enforcement consistency
|
||||||
- **Community Managers**: Day-to-day community operations and member engagement
|
- **Community Managers**: Day-to-day community operations and member engagement
|
||||||
- **Technical Manager**: Day-to-day technical operations, code reviews, and technical contributor coordination
|
- **Technical Manager**: Day-to-day technical operations, code reviews, and technical contributor coordination
|
||||||
- **Technical Administrators**: Platform infrastructure management and strategic technical planning
|
- **Technical Administrators**: Platform infrastructure management and strategic technical planning
|
||||||
|
|
||||||
#### 2.1.3 Specialist Leadership
|
#### 2.1.3. Specialist Leadership
|
||||||
|
|
||||||
- **Accessibility Coordinator**: Ensuring inclusive design and accommodation
|
- **Accessibility Coordinator**: Ensuring inclusive design and accommodation
|
||||||
- **Crisis Response Coordinator**: Mental health and emergency situation management
|
- **Crisis Response Coordinator**: Mental health and emergency situation management
|
||||||
@@ -56,7 +56,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- **Support Team Leader**: Oversight and coordination of community support operations
|
- **Support Team Leader**: Oversight and coordination of community support operations
|
||||||
- **Community Growth Specialist**: Member recruitment, retention, and community expansion initiatives
|
- **Community Growth Specialist**: Member recruitment, retention, and community expansion initiatives
|
||||||
|
|
||||||
#### 2.1.4 Volunteer Leadership
|
#### 2.1.4. Volunteer Leadership
|
||||||
|
|
||||||
- **Moderators**: Front-line community moderation and member support
|
- **Moderators**: Front-line community moderation and member support
|
||||||
- **Mentors**: New member guidance and peer support programmes
|
- **Mentors**: New member guidance and peer support programmes
|
||||||
@@ -67,7 +67,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- **Quality Assurance Coordinator**: Testing and quality control for community platforms and resources
|
- **Quality Assurance Coordinator**: Testing and quality control for community platforms and resources
|
||||||
- **Data and Analytics Coordinator**: Community metrics analysis and reporting
|
- **Data and Analytics Coordinator**: Community metrics analysis and reporting
|
||||||
|
|
||||||
#### 2.1.5 Support Team
|
#### 2.1.5. Support Team
|
||||||
|
|
||||||
- **Community Support Specialists**: General member assistance and issue resolution
|
- **Community Support Specialists**: General member assistance and issue resolution
|
||||||
- **Technical Support Representatives**: Platform and technical assistance for community members
|
- **Technical Support Representatives**: Platform and technical assistance for community members
|
||||||
@@ -75,9 +75,9 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- **Member Relations Specialists**: Member onboarding and relationship management
|
- **Member Relations Specialists**: Member onboarding and relationship management
|
||||||
- **Documentation Support Technicians**: Maintenance and improvement of community documentation
|
- **Documentation Support Technicians**: Maintenance and improvement of community documentation
|
||||||
|
|
||||||
### 2.2 Role Responsibilities
|
### 2.2. Role Responsibilities
|
||||||
|
|
||||||
#### 2.2.1 Executive Leadership Responsibilities
|
#### 2.2.1. Executive Leadership Responsibilities
|
||||||
|
|
||||||
**Community Director:**
|
**Community Director:**
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- Coordinate with external legal counsel when necessary
|
- Coordinate with external legal counsel when necessary
|
||||||
- Maintain awareness of relevant laws and regulations affecting community operations
|
- Maintain awareness of relevant laws and regulations affecting community operations
|
||||||
|
|
||||||
#### 2.2.2 Operational Leadership Responsibilities
|
#### 2.2.2. Operational Leadership Responsibilities
|
||||||
|
|
||||||
**Head Moderator:**
|
**Head Moderator:**
|
||||||
|
|
||||||
@@ -135,10 +135,10 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- Implement security protocols and system monitoring
|
- Implement security protocols and system monitoring
|
||||||
- Coordinate strategic technical planning and architecture decisions
|
- Coordinate strategic technical planning and architecture decisions
|
||||||
- Oversee system upgrades, maintenance, and disaster recovery procedures
|
- Oversee system upgrades, maintenance, and disaster recovery procedures
|
||||||
- Collaborate with Technical Manager on technical project prioritization
|
- Collaborate with Technical Manager on technical project prioritisation
|
||||||
- Ensure platform scalability and performance optimization
|
- Ensure platform scalability and performance optimisation
|
||||||
|
|
||||||
#### 2.2.3 Specialist Leadership Responsibilities
|
#### 2.2.3. Specialist Leadership Responsibilities
|
||||||
|
|
||||||
**Accessibility Coordinator:**
|
**Accessibility Coordinator:**
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
|
|
||||||
**Events Coordinator:**
|
**Events Coordinator:**
|
||||||
|
|
||||||
- Plan and organize community activities, events, and engagement programmes
|
- Plan and organise community activities, events, and engagement programmes
|
||||||
- Coordinate with other leadership roles to ensure event alignment with community goals
|
- Coordinate with other leadership roles to ensure event alignment with community goals
|
||||||
- Manage event logistics, scheduling, and resource allocation
|
- Manage event logistics, scheduling, and resource allocation
|
||||||
- Develop community engagement strategies to increase participation
|
- Develop community engagement strategies to increase participation
|
||||||
@@ -179,18 +179,18 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
**Training and Development Coordinator:**
|
**Training and Development Coordinator:**
|
||||||
|
|
||||||
- Develop and maintain comprehensive training curricula for all leadership roles
|
- Develop and maintain comprehensive training curricula for all leadership roles
|
||||||
- Coordinate onboarding programs for new leaders and community members
|
- Coordinate onboarding programmes for new leaders and community members
|
||||||
- Manage mentorship program structure, matching, and effectiveness monitoring
|
- Manage mentorship programme structure, matching, and effectiveness monitoring
|
||||||
- Oversee professional development opportunities and educational resources
|
- Oversee professional development opportunities and educational resources
|
||||||
- Ensure consistent training standards and quality across all programs
|
- Ensure consistent training standards and quality across all programmes
|
||||||
- Coordinate with external training providers and professional development opportunities
|
- Coordinate with external training providers and professional development opportunities
|
||||||
- Evaluate training effectiveness and implement continuous improvements
|
- Evaluate training effectiveness and implement continuous improvements
|
||||||
|
|
||||||
**Partnership and Collaboration Coordinator:**
|
**Partnership and Collaboration Coordinator:**
|
||||||
|
|
||||||
- Manage relationships with other communities, organizations, and external partners
|
- Manage relationships with other communities, organisations, and external partners
|
||||||
- Coordinate collaborative projects and cross-community initiatives
|
- Coordinate collaborative projects and cross-community initiatives
|
||||||
- Oversee guest speaker programs and external educational opportunities
|
- Oversee guest speaker programmes and external educational opportunities
|
||||||
- Manage sponsorship agreements and partnership development
|
- Manage sponsorship agreements and partnership development
|
||||||
- Facilitate inter-community events and collaborative activities
|
- Facilitate inter-community events and collaborative activities
|
||||||
- Develop and maintain partnership agreements and memoranda of understanding
|
- Develop and maintain partnership agreements and memoranda of understanding
|
||||||
@@ -205,7 +205,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- Handle escalated support issues and complex member concerns requiring leadership intervention
|
- Handle escalated support issues and complex member concerns requiring leadership intervention
|
||||||
- Coordinate support team scheduling and coverage to ensure consistent availability
|
- Coordinate support team scheduling and coverage to ensure consistent availability
|
||||||
- Collaborate with other leadership roles to identify support needs and resource requirements
|
- Collaborate with other leadership roles to identify support needs and resource requirements
|
||||||
- Implement support team improvements and process optimizations based on feedback and analytics
|
- Implement support team improvements and process optimisations based on feedback and analytics
|
||||||
- Serve as primary liaison between support team and executive/operational leadership
|
- Serve as primary liaison between support team and executive/operational leadership
|
||||||
- Manage support team knowledge base and ensure consistent information sharing
|
- Manage support team knowledge base and ensure consistent information sharing
|
||||||
|
|
||||||
@@ -215,15 +215,15 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- Analyse community growth metrics, member acquisition trends, and retention patterns
|
- Analyse community growth metrics, member acquisition trends, and retention patterns
|
||||||
- Design and execute outreach campaigns to attract new members from target demographics
|
- Design and execute outreach campaigns to attract new members from target demographics
|
||||||
- Coordinate with Communications and Outreach Coordinator on growth-focused messaging and content
|
- Coordinate with Communications and Outreach Coordinator on growth-focused messaging and content
|
||||||
- Implement member retention programs and initiatives to reduce community churn
|
- Implement member retention programmes and initiatives to reduce community churn
|
||||||
- Identify and develop community growth opportunities through partnerships and collaborations
|
- Identify and develop community growth opportunities through partnerships and collaborations
|
||||||
- Monitor and optimize member onboarding processes to improve new member experience and retention
|
- Monitor and optimise member onboarding processes to improve new member experience and retention
|
||||||
- Conduct market research and competitive analysis to identify growth opportunities
|
- Conduct market research and competitive analysis to identify growth opportunities
|
||||||
- Create and manage referral programs and member advocacy initiatives
|
- Create and manage referral programmes and member advocacy initiatives
|
||||||
- Track and report on key growth metrics including member acquisition, retention, and lifetime value
|
- Track and report on key growth metrics including member acquisition, retention, and lifetime value
|
||||||
- Collaborate with Events Coordinator to design growth-focused community activities and engagement programs
|
- Collaborate with Events Coordinator to design growth-focused community activities and engagement programmes
|
||||||
|
|
||||||
#### 2.2.4 Volunteer Leadership Responsibilities
|
#### 2.2.4. Volunteer Leadership Responsibilities
|
||||||
|
|
||||||
**Moderators:**
|
**Moderators:**
|
||||||
|
|
||||||
@@ -245,12 +245,12 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
|
|
||||||
**Subject Matter Experts:**
|
**Subject Matter Experts:**
|
||||||
|
|
||||||
- Provide specialized knowledge and expertise in designated areas
|
- Provide specialised knowledge and expertise in designated areas
|
||||||
- Create educational content and resources for community members
|
- Create educational content and resources for community members
|
||||||
- Offer technical support and guidance within their areas of expertise
|
- Offer technical support and guidance within their areas of expertise
|
||||||
- Lead workshops, discussions, and educational initiatives
|
- Lead workshops, discussions, and educational initiatives
|
||||||
- Serve as consultants to leadership team on specialized topics
|
- Serve as consultants to leadership team on specialised topics
|
||||||
- Mentor other community members in developing specialized skills
|
- Mentor other community members in developing specialised skills
|
||||||
|
|
||||||
**Technical Contributors:**
|
**Technical Contributors:**
|
||||||
|
|
||||||
@@ -298,10 +298,10 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
- Manage community surveys and feedback analysis for leadership decision-making
|
- Manage community surveys and feedback analysis for leadership decision-making
|
||||||
- Support leadership team with data insights and trend identification
|
- Support leadership team with data insights and trend identification
|
||||||
- Maintain privacy-compliant data collection and analysis practices
|
- Maintain privacy-compliant data collection and analysis practices
|
||||||
- Develop dashboards and visualization tools for community metrics monitoring
|
- Develop dashboards and visualisation tools for community metrics monitoring
|
||||||
- Coordinate with other leadership roles to identify key performance indicators and success metrics
|
- Coordinate with other leadership roles to identify key performance indicators and success metrics
|
||||||
|
|
||||||
#### 2.2.5 Support Team Responsibilities
|
#### 2.2.5. Support Team Responsibilities
|
||||||
|
|
||||||
**Community Support Specialists:**
|
**Community Support Specialists:**
|
||||||
|
|
||||||
@@ -327,7 +327,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
|
|
||||||
- Assist community members with content creation, formatting, and publishing
|
- Assist community members with content creation, formatting, and publishing
|
||||||
- Provide guidance on community content guidelines and best practices
|
- Provide guidance on community content guidelines and best practices
|
||||||
- Help members optimize their contributions for accessibility and engagement
|
- Help members optimise their contributions for accessibility and engagement
|
||||||
- Coordinate with Subject Matter Experts to ensure content accuracy and quality
|
- Coordinate with Subject Matter Experts to ensure content accuracy and quality
|
||||||
- Manage content creation resources, templates, and style guides
|
- Manage content creation resources, templates, and style guides
|
||||||
- Support community content initiatives and collaborative projects
|
- Support community content initiatives and collaborative projects
|
||||||
@@ -337,7 +337,7 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
|
|
||||||
- Facilitate new member onboarding and integration into community culture
|
- Facilitate new member onboarding and integration into community culture
|
||||||
- Serve as primary point of contact for member concerns and relationship issues
|
- Serve as primary point of contact for member concerns and relationship issues
|
||||||
- Coordinate welcome programs and new member orientation activities
|
- Coordinate welcome programmes and new member orientation activities
|
||||||
- Monitor member satisfaction and engagement levels across the community
|
- Monitor member satisfaction and engagement levels across the community
|
||||||
- Mediate minor conflicts and facilitate communication between members
|
- Mediate minor conflicts and facilitate communication between members
|
||||||
- Collect member feedback and suggestions for community improvements
|
- Collect member feedback and suggestions for community improvements
|
||||||
@@ -355,11 +355,11 @@ Our community leadership operates through a structured hierarchy designed to ens
|
|||||||
|
|
||||||
## 3. Selection and Appointment Processes
|
## 3. Selection and Appointment Processes
|
||||||
|
|
||||||
### 3.1 Leadership Selection Criteria
|
### 3.1. Leadership Selection Criteria
|
||||||
|
|
||||||
All community leaders must demonstrate:
|
All community leaders must demonstrate:
|
||||||
|
|
||||||
#### 3.1.1 Essential Qualifications
|
#### 3.1.1. Essential Qualifications
|
||||||
|
|
||||||
- **Community Standing**: Minimum six (6) months of positive community participation
|
- **Community Standing**: Minimum six (6) months of positive community participation
|
||||||
- **Conduct Record**: Clean disciplinary record with no serious violations
|
- **Conduct Record**: Clean disciplinary record with no serious violations
|
||||||
@@ -367,16 +367,16 @@ All community leaders must demonstrate:
|
|||||||
- **Commitment Availability**: Adequate time and energy to fulfil role responsibilities
|
- **Commitment Availability**: Adequate time and energy to fulfil role responsibilities
|
||||||
- **Values Alignment**: Strong commitment to community principles and inclusive practices
|
- **Values Alignment**: Strong commitment to community principles and inclusive practices
|
||||||
|
|
||||||
#### 3.1.2 Preferred Qualifications
|
#### 3.1.2. Preferred Qualifications
|
||||||
|
|
||||||
- **Prior Leadership Experience**: Previous volunteer or professional leadership roles
|
- **Prior Leadership Experience**: Previous volunteer or professional leadership roles
|
||||||
- **Specialised Knowledge**: Relevant expertise in moderation, community management, or technical areas
|
- **Specialised Knowledge**: Relevant expertise in moderation, community management, or technical areas
|
||||||
- **Mentorship Capability**: Demonstrated ability to guide and support other community members
|
- **Mentorship Capability**: Demonstrated ability to guide and support other community members
|
||||||
- **Crisis Management Experience**: Skills in conflict resolution and emergency response
|
- **Crisis Management Experience**: Skills in conflict resolution and emergency response
|
||||||
|
|
||||||
### 3.2 Selection Processes
|
### 3.2. Selection Processes
|
||||||
|
|
||||||
#### 3.2.1 Application and Nomination Process
|
#### 3.2.1. Application and Nomination Process
|
||||||
|
|
||||||
**Open Applications:**
|
**Open Applications:**
|
||||||
|
|
||||||
@@ -392,13 +392,13 @@ All community leaders must demonstrate:
|
|||||||
- Existing leadership team provides assessments of candidate suitability
|
- Existing leadership team provides assessments of candidate suitability
|
||||||
- Transparent scoring rubrics ensure fair and consistent evaluation
|
- Transparent scoring rubrics ensure fair and consistent evaluation
|
||||||
|
|
||||||
#### 3.2.2 Interview and Assessment Process
|
#### 3.2.2. Interview and Assessment Process
|
||||||
|
|
||||||
**Structured Interviews:**
|
**Structured Interviews:**
|
||||||
|
|
||||||
- All candidates participate in structured interviews with existing leadership
|
- All candidates participate in structured interviews with existing leadership
|
||||||
- Scenario-based questions assess decision-making capabilities and values alignment
|
- Scenario-based questions assess decision-making capabilities and values alignment
|
||||||
- Technical competency assessments for roles requiring specialized skills
|
- Technical competency assessments for roles requiring specialised skills
|
||||||
- Cultural fit evaluation ensures compatibility with community values and practices
|
- Cultural fit evaluation ensures compatibility with community values and practices
|
||||||
|
|
||||||
**Community Engagement Assessment:**
|
**Community Engagement Assessment:**
|
||||||
@@ -408,9 +408,9 @@ All community leaders must demonstrate:
|
|||||||
- Ethical decision-making assessments ensure integrity and sound judgement
|
- Ethical decision-making assessments ensure integrity and sound judgement
|
||||||
- Commitment verification confirms availability and dedication to the role
|
- Commitment verification confirms availability and dedication to the role
|
||||||
|
|
||||||
### 3.3 Appointment and Transition
|
### 3.3. Appointment and Transition
|
||||||
|
|
||||||
#### 3.3.1 Final Selection and Announcement
|
#### 3.3.1. Final Selection and Announcement
|
||||||
|
|
||||||
**Decision Making:**
|
**Decision Making:**
|
||||||
|
|
||||||
@@ -428,9 +428,9 @@ All community leaders must demonstrate:
|
|||||||
|
|
||||||
## 4. Leadership Accountability and Oversight
|
## 4. Leadership Accountability and Oversight
|
||||||
|
|
||||||
### 4.1 Performance Standards and Expectations
|
### 4.1. Performance Standards and Expectations
|
||||||
|
|
||||||
#### 4.1.1 Ongoing Performance Metrics
|
#### 4.1.1. Ongoing Performance Metrics
|
||||||
|
|
||||||
All community leaders are evaluated on:
|
All community leaders are evaluated on:
|
||||||
|
|
||||||
@@ -448,7 +448,7 @@ All community leaders are evaluated on:
|
|||||||
- Professional development and skills enhancement
|
- Professional development and skills enhancement
|
||||||
- Collaboration effectiveness with other leadership team members
|
- Collaboration effectiveness with other leadership team members
|
||||||
|
|
||||||
#### 4.1.2 Regular Review Processes
|
#### 4.1.2. Regular Review Processes
|
||||||
|
|
||||||
**Quarterly Performance Reviews:**
|
**Quarterly Performance Reviews:**
|
||||||
|
|
||||||
@@ -464,9 +464,9 @@ All community leaders are evaluated on:
|
|||||||
- Leadership development planning and career progression discussions
|
- Leadership development planning and career progression discussions
|
||||||
- Reappointment decisions based on performance and community needs
|
- Reappointment decisions based on performance and community needs
|
||||||
|
|
||||||
### 4.2 Community Feedback and Input Mechanisms
|
### 4.2. Community Feedback and Input Mechanisms
|
||||||
|
|
||||||
#### 4.2.1 Regular Feedback Channels
|
#### 4.2.1. Regular Feedback Channels
|
||||||
|
|
||||||
**Monthly Community Forums:**
|
**Monthly Community Forums:**
|
||||||
|
|
||||||
@@ -482,7 +482,7 @@ All community leaders are evaluated on:
|
|||||||
- Community liaison positions to facilitate communication between members and leadership
|
- Community liaison positions to facilitate communication between members and leadership
|
||||||
- Transparent communication about leadership decisions and their rationales
|
- Transparent communication about leadership decisions and their rationales
|
||||||
|
|
||||||
#### 4.2.2 Formal Accountability Processes
|
#### 4.2.2. Formal Accountability Processes
|
||||||
|
|
||||||
**Community Confidence Measures:**
|
**Community Confidence Measures:**
|
||||||
|
|
||||||
@@ -491,9 +491,9 @@ All community leaders are evaluated on:
|
|||||||
- Transparent reporting of community feedback themes and leadership responses
|
- Transparent reporting of community feedback themes and leadership responses
|
||||||
- Regular town hall meetings for community-wide discussion of governance issues
|
- Regular town hall meetings for community-wide discussion of governance issues
|
||||||
|
|
||||||
### 4.3 Leadership Standards Enforcement
|
### 4.3. Leadership Standards Enforcement
|
||||||
|
|
||||||
#### 4.3.1 Misconduct Investigation Procedures
|
#### 4.3.1. Misconduct Investigation Procedures
|
||||||
|
|
||||||
When concerns about leadership conduct arise:
|
When concerns about leadership conduct arise:
|
||||||
|
|
||||||
@@ -511,7 +511,7 @@ When concerns about leadership conduct arise:
|
|||||||
- Independent review panels including community member representation
|
- Independent review panels including community member representation
|
||||||
- Clear standards of evidence and burden of proof requirements
|
- Clear standards of evidence and burden of proof requirements
|
||||||
|
|
||||||
#### 4.3.2 Disciplinary Measures and Consequences
|
#### 4.3.2. Disciplinary Measures and Consequences
|
||||||
|
|
||||||
**Progressive Disciplinary System:**
|
**Progressive Disciplinary System:**
|
||||||
|
|
||||||
@@ -529,9 +529,9 @@ When concerns about leadership conduct arise:
|
|||||||
|
|
||||||
## 5. Leadership Development and Support
|
## 5. Leadership Development and Support
|
||||||
|
|
||||||
### 5.1 Training and Professional Development
|
### 5.1. Training and Professional Development
|
||||||
|
|
||||||
#### 5.1.1 Mandatory Training Programs
|
#### 5.1.1. Mandatory Training Programs
|
||||||
|
|
||||||
All community leaders must complete:
|
All community leaders must complete:
|
||||||
|
|
||||||
@@ -551,13 +551,13 @@ All community leaders must complete:
|
|||||||
- Technical administration and security for technical leadership
|
- Technical administration and security for technical leadership
|
||||||
- Event planning and community engagement for activities coordinators
|
- Event planning and community engagement for activities coordinators
|
||||||
|
|
||||||
#### 5.1.2 Ongoing Development Opportunities
|
#### 5.1.2. Ongoing Development Opportunities
|
||||||
|
|
||||||
**Skill Enhancement Programs:**
|
**Skill Enhancement Programs:**
|
||||||
|
|
||||||
- Leadership coaching and mentorship opportunities
|
- Leadership coaching and mentorship opportunities
|
||||||
- External training and conference attendance support
|
- External training and conference attendance support
|
||||||
- Cross-functional experience and role shadowing programs
|
- Cross-functional experience and role shadowing programmes
|
||||||
- Community management and governance best practices workshops
|
- Community management and governance best practices workshops
|
||||||
|
|
||||||
**Personal Development Support:**
|
**Personal Development Support:**
|
||||||
@@ -567,15 +567,15 @@ All community leaders must complete:
|
|||||||
- Cultural competency and diversity, equity, inclusion education
|
- Cultural competency and diversity, equity, inclusion education
|
||||||
- Technology skills and platform administration training
|
- Technology skills and platform administration training
|
||||||
|
|
||||||
### 5.2 Leadership Support Systems
|
### 5.2. Leadership Support Systems
|
||||||
|
|
||||||
#### 5.2.1 Peer Support Networks
|
#### 5.2.1. Peer Support Networks
|
||||||
|
|
||||||
**Leadership Team Collaboration:**
|
**Leadership Team Collaboration:**
|
||||||
|
|
||||||
- Regular leadership team meetings for coordination and mutual support
|
- Regular leadership team meetings for coordination and mutual support
|
||||||
- Peer mentoring partnerships for experience sharing and guidance
|
- Peer mentoring partnerships for experience sharing and guidance
|
||||||
- Cross-training programs to ensure coverage and capability development
|
- Cross-training programmes to ensure coverage and capability development
|
||||||
- Team-building activities and relationship-strengthening initiatives
|
- Team-building activities and relationship-strengthening initiatives
|
||||||
|
|
||||||
**External Professional Networks:**
|
**External Professional Networks:**
|
||||||
@@ -585,14 +585,14 @@ All community leaders must complete:
|
|||||||
- Industry conference attendance and professional development events
|
- Industry conference attendance and professional development events
|
||||||
- Access to external coaching and consultation resources
|
- Access to external coaching and consultation resources
|
||||||
|
|
||||||
#### 5.2.2 Wellness and Burnout Prevention
|
#### 5.2.2. Wellness and Burnout Prevention
|
||||||
|
|
||||||
**Workload Management:**
|
**Workload Management:**
|
||||||
|
|
||||||
- Clear role boundaries and expectation setting to prevent overextension
|
- Clear role boundaries and expectation setting to prevent overextension
|
||||||
- Regular workload assessment and redistribution when necessary
|
- Regular workload assessment and redistribution when necessary
|
||||||
- Mandatory rest periods and vacation time for volunteer leaders
|
- Mandatory rest periods and vacation time for volunteer leaders
|
||||||
- Recognition and appreciation programs to maintain motivation and satisfaction
|
- Recognition and appreciation programmes to maintain motivation and satisfaction
|
||||||
|
|
||||||
**Mental Health Support:**
|
**Mental Health Support:**
|
||||||
|
|
||||||
@@ -602,15 +602,15 @@ All community leaders must complete:
|
|||||||
|
|
||||||
## 6. Succession Planning and Continuity
|
## 6. Succession Planning and Continuity
|
||||||
|
|
||||||
### 6.1 Leadership Succession Framework
|
### 6.1. Leadership Succession Framework
|
||||||
|
|
||||||
#### 6.1.1 Planned Succession Processes
|
#### 6.1.1. Planned Succession Processes
|
||||||
|
|
||||||
**Leadership Pipeline Development:**
|
**Leadership Pipeline Development:**
|
||||||
|
|
||||||
- Identification and mentorship of potential future leaders
|
- Identification and mentorship of potential future leaders
|
||||||
- Progressive responsibility assignments to prepare succession candidates
|
- Progressive responsibility assignments to prepare succession candidates
|
||||||
- Cross-training programs to ensure multiple qualified candidates for key roles
|
- Cross-training programmes to ensure multiple qualified candidates for key roles
|
||||||
- Regular succession planning reviews and candidate development assessment
|
- Regular succession planning reviews and candidate development assessment
|
||||||
|
|
||||||
**Transition Management:**
|
**Transition Management:**
|
||||||
@@ -620,7 +620,7 @@ All community leaders must complete:
|
|||||||
- Interim leadership arrangements during transition periods
|
- Interim leadership arrangements during transition periods
|
||||||
- Community communication strategies for leadership changes
|
- Community communication strategies for leadership changes
|
||||||
|
|
||||||
#### 6.1.2 Emergency Succession Procedures
|
#### 6.1.2. Emergency Succession Procedures
|
||||||
|
|
||||||
**Crisis Leadership Arrangements:**
|
**Crisis Leadership Arrangements:**
|
||||||
|
|
||||||
@@ -629,9 +629,9 @@ All community leaders must complete:
|
|||||||
- Rapid response team formation for crisis management
|
- Rapid response team formation for crisis management
|
||||||
- Community communication protocols for emergency leadership changes
|
- Community communication protocols for emergency leadership changes
|
||||||
|
|
||||||
### 6.2 Knowledge Management and Institutional Memory
|
### 6.2. Knowledge Management and Institutional Memory
|
||||||
|
|
||||||
#### 6.2.1 Documentation and Record-Keeping
|
#### 6.2.1. Documentation and Record-Keeping
|
||||||
|
|
||||||
**Leadership Knowledge Base:**
|
**Leadership Knowledge Base:**
|
||||||
|
|
||||||
@@ -649,9 +649,9 @@ All community leaders must complete:
|
|||||||
|
|
||||||
## 7. Community Transparency and Communication
|
## 7. Community Transparency and Communication
|
||||||
|
|
||||||
### 7.1 Transparency Requirements
|
### 7.1. Transparency Requirements
|
||||||
|
|
||||||
#### 7.1.1 Public Reporting and Disclosure
|
#### 7.1.1. Public Reporting and Disclosure
|
||||||
|
|
||||||
**Regular Community Updates:**
|
**Regular Community Updates:**
|
||||||
|
|
||||||
@@ -667,7 +667,7 @@ All community leaders must complete:
|
|||||||
- Open meeting minutes and records for community leadership discussions
|
- Open meeting minutes and records for community leadership discussions
|
||||||
- Clear communication of appeals processes and outcomes
|
- Clear communication of appeals processes and outcomes
|
||||||
|
|
||||||
#### 7.1.2 Community Engagement and Input
|
#### 7.1.2. Community Engagement and Input
|
||||||
|
|
||||||
**Participatory Governance:**
|
**Participatory Governance:**
|
||||||
|
|
||||||
@@ -678,9 +678,9 @@ All community leaders must complete:
|
|||||||
|
|
||||||
## 8. Policy Implementation and Review
|
## 8. Policy Implementation and Review
|
||||||
|
|
||||||
### 8.2 Regular Review and Updates
|
### 8.2. Regular Review and Updates
|
||||||
|
|
||||||
#### 8.2.1 Policy Review Schedule
|
#### 8.2.1. Policy Review Schedule
|
||||||
|
|
||||||
**Annual Reviews:**
|
**Annual Reviews:**
|
||||||
|
|
||||||
@@ -696,9 +696,9 @@ All community leaders must complete:
|
|||||||
- Regular benchmarking against community management best practices
|
- Regular benchmarking against community management best practices
|
||||||
- Ongoing legal and regulatory compliance verification
|
- Ongoing legal and regulatory compliance verification
|
||||||
|
|
||||||
### 8.2 Amendment Procedures
|
### 8.2. Amendment Procedures
|
||||||
|
|
||||||
#### 8.2.1 Policy Change Process
|
#### 8.2.1. Policy Change Process
|
||||||
|
|
||||||
**Community Input Requirements:**
|
**Community Input Requirements:**
|
||||||
|
|
||||||
@@ -709,9 +709,9 @@ All community leaders must complete:
|
|||||||
|
|
||||||
**Implementation and Communication:**
|
**Implementation and Communication:**
|
||||||
|
|
||||||
- Clear communication of policy changes and effective dates
|
- Clear communication of policy changes
|
||||||
- Training updates for all leadership team members
|
- Training updates for all leadership team members
|
||||||
- Community education and awareness programs for new requirements
|
- Community education and awareness programmes for new requirements
|
||||||
- Regular monitoring of policy effectiveness and community impact
|
- Regular monitoring of policy effectiveness and community impact
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -724,4 +724,4 @@ This Policy represents our collective commitment to maintaining excellent leader
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
_This Community Leadership and Governance Policy was created on 15 September 2025. For questions about this Policy or to provide feedback on leadership performance, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct._
|
_This Community Leadership and Governance Policy provides comprehensive information about leadership and governance. For questions about this Policy or to provide feedback on leadership performance, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct._
|
||||||
|
|||||||
@@ -4,11 +4,11 @@ title: Community Recognition and Appreciation Policy
|
|||||||
|
|
||||||
## 1. Foundation and Philosophy
|
## 1. Foundation and Philosophy
|
||||||
|
|
||||||
### 1.1 Introduction and Purpose
|
### 1.1. Introduction and Purpose
|
||||||
|
|
||||||
This Community Recognition and Appreciation Policy (hereinafter referred to as "the Policy") establishes our comprehensive framework for acknowledging, celebrating, and appreciating the diverse contributions of community members. This Policy recognises that fostering a truly welcoming and inclusive environment requires intentional appreciation of member efforts, celebration of diverse talents and contributions, and creation of meaningful recognition systems that motivate continued positive engagement.
|
This Community Recognition and Appreciation Policy (hereinafter referred to as "the Policy") establishes our comprehensive framework for acknowledging, celebrating, and appreciating the diverse contributions of community members. This Policy recognises that fostering a truly welcoming and inclusive environment requires intentional appreciation of member efforts, celebration of diverse talents and contributions, and creation of meaningful recognition systems that motivate continued positive engagement.
|
||||||
|
|
||||||
### 1.2 Core Principles
|
### 1.2. Core Principles
|
||||||
|
|
||||||
Our recognition and appreciation approach is founded upon:
|
Our recognition and appreciation approach is founded upon:
|
||||||
|
|
||||||
@@ -20,11 +20,11 @@ Our recognition and appreciation approach is founded upon:
|
|||||||
|
|
||||||
**(d)** **Cultural Sensitivity**: Recognition practices that respect diverse cultural approaches to appreciation and celebration;
|
**(d)** **Cultural Sensitivity**: Recognition practices that respect diverse cultural approaches to appreciation and celebration;
|
||||||
|
|
||||||
**(e)** **Sustainable Systems**: Long-term recognition programs that maintain motivation and community engagement;
|
**(e)** **Sustainable Systems**: Long-term recognition programmes that maintain motivation and community engagement;
|
||||||
|
|
||||||
**(f)** **Community-Driven Values**: Recognition that reinforces positive community culture and shared values.
|
**(f)** **Community-Driven Values**: Recognition that reinforces positive community culture and shared values.
|
||||||
|
|
||||||
### 1.3 Recognition Philosophy
|
### 1.3. Recognition Philosophy
|
||||||
|
|
||||||
We believe that every community member contributes value in unique ways, and our recognition systems are designed to:
|
We believe that every community member contributes value in unique ways, and our recognition systems are designed to:
|
||||||
- Acknowledge contributions both large and small
|
- Acknowledge contributions both large and small
|
||||||
@@ -33,15 +33,15 @@ We believe that every community member contributes value in unique ways, and our
|
|||||||
- Build community connections and mutual appreciation
|
- Build community connections and mutual appreciation
|
||||||
- Encourage continued positive contribution and community involvement
|
- Encourage continued positive contribution and community involvement
|
||||||
|
|
||||||
### 1.4 Legal Framework Integration
|
### 1.4. Legal Framework Integration
|
||||||
|
|
||||||
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Privacy Policy, Community Code of Conduct, and Community Leadership and Governance Policy, all of which are incorporated herein by reference.
|
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Privacy Policy, Community Code of Conduct, and Community Leadership and Governance Policy, all of which are incorporated herein by reference.
|
||||||
|
|
||||||
## 2. Recognition Categories and Programs
|
## 2. Recognition Categories and Programs
|
||||||
|
|
||||||
### 2.1 Regular Recognition Programs
|
### 2.1. Regular Recognition Programmes
|
||||||
|
|
||||||
#### 2.1.1 Daily Appreciation Initiatives
|
#### 2.1.1. Daily Appreciation Initiatives
|
||||||
|
|
||||||
**Community Gratitude Practices:**
|
**Community Gratitude Practices:**
|
||||||
- Daily appreciation messages highlighting specific member contributions
|
- Daily appreciation messages highlighting specific member contributions
|
||||||
@@ -55,7 +55,7 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- Recognition of members who provide assistance, answer questions, or offer guidance
|
- Recognition of members who provide assistance, answer questions, or offer guidance
|
||||||
- Acknowledgement of members who demonstrate inclusive and welcoming behaviour
|
- Acknowledgement of members who demonstrate inclusive and welcoming behaviour
|
||||||
|
|
||||||
#### 2.1.2 Monthly Recognition Programs
|
#### 2.1.2. Monthly Recognition Programmes
|
||||||
|
|
||||||
**Member of the Month Awards:**
|
**Member of the Month Awards:**
|
||||||
- Recognition for outstanding community contribution and positive impact
|
- Recognition for outstanding community contribution and positive impact
|
||||||
@@ -69,9 +69,9 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- **Innovator of the Month**: Members who bring creative ideas, solutions, or new perspectives
|
- **Innovator of the Month**: Members who bring creative ideas, solutions, or new perspectives
|
||||||
- **Inclusivity Champion**: Members who actively promote inclusive practices and welcoming environments
|
- **Inclusivity Champion**: Members who actively promote inclusive practices and welcoming environments
|
||||||
|
|
||||||
### 2.2 Special Recognition Programs
|
### 2.2. Special Recognition Programmes
|
||||||
|
|
||||||
#### 2.2.1 Annual Achievement Awards
|
#### 2.2.1. Annual Achievement Awards
|
||||||
|
|
||||||
**Excellence in Community Building:**
|
**Excellence in Community Building:**
|
||||||
- Outstanding Community Leader Award for members who demonstrate exceptional leadership qualities
|
- Outstanding Community Leader Award for members who demonstrate exceptional leadership qualities
|
||||||
@@ -85,7 +85,7 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
- **Behind-the-Scenes Hero**: Members who contribute significantly in less visible but essential ways
|
- **Behind-the-Scenes Hero**: Members who contribute significantly in less visible but essential ways
|
||||||
- **Community Bridge Builder**: Members who facilitate connections and resolve conflicts constructively
|
- **Community Bridge Builder**: Members who facilitate connections and resolve conflicts constructively
|
||||||
|
|
||||||
#### 2.2.2 Milestone Celebration Programs
|
#### 2.2.2. Milestone Celebration Programs
|
||||||
|
|
||||||
**Participation Milestone Recognition:**
|
**Participation Milestone Recognition:**
|
||||||
- Anniversary celebrations for community membership milestones (1 year, 2 years, 5 years)
|
- Anniversary celebrations for community membership milestones (1 year, 2 years, 5 years)
|
||||||
@@ -104,9 +104,9 @@ This Policy operates within our comprehensive legal and policy framework, includ
|
|||||||
Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuovSixbXFEnkYq-3Gp-bZMH-n__PNRKw
|
Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuovSixbXFEnkYq-3Gp-bZMH-n__PNRKw
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### 3.1 Community-Driven Nomination Systems
|
### 3.1. Community-Driven Nomination Systems
|
||||||
|
|
||||||
#### 3.1.1 Peer Nomination Processes
|
#### 3.1.1. Peer Nomination Processes
|
||||||
|
|
||||||
**Open Nomination Periods:**
|
**Open Nomination Periods:**
|
||||||
- Monthly nomination windows allowing any community member to nominate others
|
- Monthly nomination windows allowing any community member to nominate others
|
||||||
@@ -120,7 +120,7 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Focus on effort, growth, and positive community impact rather than just results
|
- Focus on effort, growth, and positive community impact rather than just results
|
||||||
- Consideration of diverse contribution types and varying participation styles
|
- Consideration of diverse contribution types and varying participation styles
|
||||||
|
|
||||||
#### 3.1.2 Selection and Review Processes
|
#### 3.1.2. Selection and Review Processes
|
||||||
|
|
||||||
**Diverse Selection Committees:**
|
**Diverse Selection Committees:**
|
||||||
- Rotating committee membership ensuring diverse perspectives and fair evaluation
|
- Rotating committee membership ensuring diverse perspectives and fair evaluation
|
||||||
@@ -134,9 +134,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Multiple reviewer assessment system for important recognition decisions
|
- Multiple reviewer assessment system for important recognition decisions
|
||||||
- Regular review of selection processes to ensure equity and effectiveness
|
- Regular review of selection processes to ensure equity and effectiveness
|
||||||
|
|
||||||
### 3.2 Recognition Frequency and Distribution
|
### 3.2. Recognition Frequency and Distribution
|
||||||
|
|
||||||
#### 3.2.1 Balanced Recognition Distribution
|
#### 3.2.1. Balanced Recognition Distribution
|
||||||
|
|
||||||
**Inclusive Recognition Practices:**
|
**Inclusive Recognition Practices:**
|
||||||
- Ensure recognition reaches members from all community areas and participation styles
|
- Ensure recognition reaches members from all community areas and participation styles
|
||||||
@@ -152,9 +152,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
## 4. Types of Contributions Valued
|
## 4. Types of Contributions Valued
|
||||||
|
|
||||||
### 4.1 Direct Community Contributions
|
### 4.1. Direct Community Contributions
|
||||||
|
|
||||||
#### 4.1.1 Active Participation and Engagement
|
#### 4.1.1. Active Participation and Engagement
|
||||||
|
|
||||||
**Discussion and Content Contributions:**
|
**Discussion and Content Contributions:**
|
||||||
- Thoughtful questions that promote community learning and engagement
|
- Thoughtful questions that promote community learning and engagement
|
||||||
@@ -168,7 +168,7 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Mentoring and guidance for less experienced community members
|
- Mentoring and guidance for less experienced community members
|
||||||
- Conflict resolution assistance and constructive mediation efforts
|
- Conflict resolution assistance and constructive mediation efforts
|
||||||
|
|
||||||
#### 4.1.2 Leadership and Initiative
|
#### 4.1.2. Leadership and Initiative
|
||||||
|
|
||||||
**Volunteer Leadership Roles:**
|
**Volunteer Leadership Roles:**
|
||||||
- Moderation activities and community standards enforcement
|
- Moderation activities and community standards enforcement
|
||||||
@@ -178,13 +178,13 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
**Innovation and Problem-Solving:**
|
**Innovation and Problem-Solving:**
|
||||||
- Creative solutions to community challenges and improvement opportunities
|
- Creative solutions to community challenges and improvement opportunities
|
||||||
- New program or initiative development and implementation
|
- New programme or initiative development and implementation
|
||||||
- Technology improvements and platform enhancement contributions
|
- Technology improvements and platform enhancement contributions
|
||||||
- Process improvements that enhance community experience and accessibility
|
- Process improvements that enhance community experience and accessibility
|
||||||
|
|
||||||
### 4.2 Indirect and Supporting Contributions
|
### 4.2. Indirect and Supporting Contributions
|
||||||
|
|
||||||
#### 4.2.1 Community Culture Building
|
#### 4.2.1. Community Culture Building
|
||||||
|
|
||||||
**Positive Environment Creation:**
|
**Positive Environment Creation:**
|
||||||
- Consistent demonstration of inclusive and welcoming behaviour
|
- Consistent demonstration of inclusive and welcoming behaviour
|
||||||
@@ -193,12 +193,12 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Celebration of other members' achievements and positive contribution acknowledgement
|
- Celebration of other members' achievements and positive contribution acknowledgement
|
||||||
|
|
||||||
**Values Demonstration and Modeling:**
|
**Values Demonstration and Modeling:**
|
||||||
- Exemplary adherence to community standards and positive behaviour modeling
|
- Exemplary adherence to community standards and positive behaviour modelling
|
||||||
- Advocacy for inclusive practices and accessibility improvements
|
- Advocacy for inclusive practices and accessibility improvements
|
||||||
- Support for marginalised community members and inclusive representation
|
- Support for marginalised community members and inclusive representation
|
||||||
- Constructive engagement with community policies and improvement processes
|
- Constructive engagement with community policies and improvement processes
|
||||||
|
|
||||||
#### 4.2.2 Behind-the-Scenes Contributions
|
#### 4.2.2. Behind-the-Scenes Contributions
|
||||||
|
|
||||||
**Administrative and Organisational Support:**
|
**Administrative and Organisational Support:**
|
||||||
- Documentation improvement and resource organisation activities
|
- Documentation improvement and resource organisation activities
|
||||||
@@ -214,9 +214,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
## 5. Recognition Methods and Formats
|
## 5. Recognition Methods and Formats
|
||||||
|
|
||||||
### 5.1 Public Recognition and Celebration
|
### 5.1. Public Recognition and Celebration
|
||||||
|
|
||||||
#### 5.1.1 Community Announcements and Features
|
#### 5.1.1. Community Announcements and Features
|
||||||
|
|
||||||
**Regular Recognition Announcements:**
|
**Regular Recognition Announcements:**
|
||||||
- Weekly appreciation announcements highlighting specific member contributions
|
- Weekly appreciation announcements highlighting specific member contributions
|
||||||
@@ -230,7 +230,7 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- "Wall of Fame" or recognition gallery featuring outstanding contributors
|
- "Wall of Fame" or recognition gallery featuring outstanding contributors
|
||||||
- Newsletter features and external communication highlighting member achievements
|
- Newsletter features and external communication highlighting member achievements
|
||||||
|
|
||||||
#### 5.1.2 Community Events and Celebrations
|
#### 5.1.2. Community Events and Celebrations
|
||||||
|
|
||||||
**Recognition Ceremony Events:**
|
**Recognition Ceremony Events:**
|
||||||
- Annual awards ceremony with community-wide attendance and celebration
|
- Annual awards ceremony with community-wide attendance and celebration
|
||||||
@@ -244,14 +244,14 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Peer appreciation sessions where members can acknowledge each other's contributions
|
- Peer appreciation sessions where members can acknowledge each other's contributions
|
||||||
- Storytelling events where members share impact stories and appreciation experiences
|
- Storytelling events where members share impact stories and appreciation experiences
|
||||||
|
|
||||||
### 5.2 Private and Personal Recognition
|
### 5.2. Private and Personal Recognition
|
||||||
|
|
||||||
#### 5.2.1 Individual Appreciation Communications
|
#### 5.2.1. Individual Appreciation Communications
|
||||||
|
|
||||||
**Personal Recognition Messages:**
|
**Personal Recognition Messages:**
|
||||||
- Direct appreciation messages from community leadership acknowledging specific contributions
|
- Direct appreciation messages from community leadership acknowledging specific contributions
|
||||||
- Personalized thank-you notes for exceptional community service and positive impact
|
- Personalized thank-you notes for exceptional community service and positive impact
|
||||||
- One-on-one appreciation conversations recognizing member efforts and growth
|
- One-on-one appreciation conversations recognising member efforts and growth
|
||||||
- Private acknowledgement of sensitive contributions that require confidential appreciation
|
- Private acknowledgement of sensitive contributions that require confidential appreciation
|
||||||
|
|
||||||
**Tailored Recognition Approaches:**
|
**Tailored Recognition Approaches:**
|
||||||
@@ -262,9 +262,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
## 6. Accessibility and Inclusion in Recognition
|
## 6. Accessibility and Inclusion in Recognition
|
||||||
|
|
||||||
### 6.1 Universal Design Recognition Systems
|
### 6.1. Universal Design Recognition Systems
|
||||||
|
|
||||||
#### 6.1.1 Accessible Recognition Participation
|
#### 6.1.1. Accessible Recognition Participation
|
||||||
|
|
||||||
**Inclusive Nomination Processes:**
|
**Inclusive Nomination Processes:**
|
||||||
- Multiple nomination methods accommodating different communication preferences and abilities
|
- Multiple nomination methods accommodating different communication preferences and abilities
|
||||||
@@ -278,7 +278,7 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Clear communication about accessibility features and accommodation availability
|
- Clear communication about accessibility features and accommodation availability
|
||||||
- Alternative participation methods for members unable to attend live recognition events
|
- Alternative participation methods for members unable to attend live recognition events
|
||||||
|
|
||||||
#### 6.1.2 Diverse Recognition Styles
|
#### 6.1.2. Diverse Recognition Styles
|
||||||
|
|
||||||
**Cultural Sensitivity in Recognition:**
|
**Cultural Sensitivity in Recognition:**
|
||||||
- Recognition practices that respect diverse cultural approaches to appreciation and celebration
|
- Recognition practices that respect diverse cultural approaches to appreciation and celebration
|
||||||
@@ -292,9 +292,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Clear communication about recognition expectations and optional participation levels
|
- Clear communication about recognition expectations and optional participation levels
|
||||||
- Flexible recognition formats that allow members to engage in ways that work best for them
|
- Flexible recognition formats that allow members to engage in ways that work best for them
|
||||||
|
|
||||||
### 6.2 Equity in Recognition Distribution
|
### 6.2. Equity in Recognition Distribution
|
||||||
|
|
||||||
#### 6.2.1 Bias Awareness and Prevention
|
#### 6.2.1. Bias Awareness and Prevention
|
||||||
|
|
||||||
**Systematic Bias Prevention:**
|
**Systematic Bias Prevention:**
|
||||||
- Regular analysis of recognition distribution patterns to identify and address potential bias
|
- Regular analysis of recognition distribution patterns to identify and address potential bias
|
||||||
@@ -308,7 +308,7 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Recognition of contributions that may be less visible but equally valuable to community health
|
- Recognition of contributions that may be less visible but equally valuable to community health
|
||||||
- Consideration of different life circumstances and availability levels in recognition evaluation
|
- Consideration of different life circumstances and availability levels in recognition evaluation
|
||||||
|
|
||||||
#### 6.2.2 Representative Recognition Outcomes
|
#### 6.2.2. Representative Recognition Outcomes
|
||||||
|
|
||||||
**Demographic Equity Monitoring:**
|
**Demographic Equity Monitoring:**
|
||||||
- Regular assessment of recognition distribution across different community demographic groups
|
- Regular assessment of recognition distribution across different community demographic groups
|
||||||
@@ -318,9 +318,9 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
## 7. Volunteer Appreciation and Support
|
## 7. Volunteer Appreciation and Support
|
||||||
|
|
||||||
### 7.1 Leadership and Staff Recognition
|
### 7.1. Leadership and Staff Recognition
|
||||||
|
|
||||||
#### 7.1.1 Volunteer Appreciation Programs
|
#### 7.1.1. Volunteer Appreciation Programs
|
||||||
|
|
||||||
**Regular Volunteer Recognition:**
|
**Regular Volunteer Recognition:**
|
||||||
- Monthly volunteer appreciation events with special recognition for leadership contributions
|
- Monthly volunteer appreciation events with special recognition for leadership contributions
|
||||||
@@ -330,11 +330,11 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
**Professional Development and Growth Support:**
|
**Professional Development and Growth Support:**
|
||||||
- Training and skill development opportunities for volunteers as appreciation for their service
|
- Training and skill development opportunities for volunteers as appreciation for their service
|
||||||
- Leadership development programs and advancement opportunities within community structure
|
- Leadership development programmes and advancement opportunities within community structure
|
||||||
- Professional reference and recommendation support for volunteers seeking career opportunities
|
- Professional reference and recommendation support for volunteers seeking career opportunities
|
||||||
- Networking opportunities and community connections that benefit volunteer development
|
- Networking opportunities and community connections that benefit volunteer development
|
||||||
|
|
||||||
#### 7.1.2 Volunteer Wellness and Burnout Prevention
|
#### 7.1.2. Volunteer Wellness and Burnout Prevention
|
||||||
|
|
||||||
**Volunteer Support Systems:**
|
**Volunteer Support Systems:**
|
||||||
- Regular check-ins with volunteers to assess satisfaction, challenges, and support needs
|
- Regular check-ins with volunteers to assess satisfaction, challenges, and support needs
|
||||||
@@ -350,25 +350,25 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
|
|
||||||
## 8. Community Feedback and Recognition Evolution
|
## 8. Community Feedback and Recognition Evolution
|
||||||
|
|
||||||
### 8.1 Community Input on Recognition Programs
|
### 8.1. Community Input on Recognition Programmes
|
||||||
|
|
||||||
#### 8.1.1 Regular Feedback Collection
|
#### 8.1.1. Regular Feedback Collection
|
||||||
|
|
||||||
**Recognition Program Evaluation:**
|
**Recognition Programme Evaluation:**
|
||||||
- Annual surveys collecting community feedback on recognition program effectiveness and satisfaction
|
- Annual surveys collecting community feedback on recognition programme effectiveness and satisfaction
|
||||||
- Focus groups with community members who have received recognition to assess program impact
|
- Focus groups with community members who have received recognition to assess programme impact
|
||||||
- Input collection from community members who have not received recognition to identify barriers and improvements
|
- Input collection from community members who have not received recognition to identify barriers and improvements
|
||||||
- Regular assessment of recognition program accessibility and inclusive representation
|
- Regular assessment of recognition programme accessibility and inclusive representation
|
||||||
|
|
||||||
**Continuous Improvement Integration:**
|
**Continuous Improvement Integration:**
|
||||||
- Community suggestion processes for recognition program enhancement and new recognition categories
|
- Community suggestion processes for recognition programme enhancement and new recognition categories
|
||||||
- Responsive program modification based on community feedback and changing needs
|
- Responsive programme modification based on community feedback and changing needs
|
||||||
- Transparent communication about recognition program changes and improvement rationales
|
- Transparent communication about recognition programme changes and improvement rationales
|
||||||
- Community involvement in recognition program planning and development processes
|
- Community involvement in recognition programme planning and development processes
|
||||||
|
|
||||||
### 8.2 Recognition Program Evolution and Innovation
|
### 8.2. Recognition Programme Evolution and Innovation
|
||||||
|
|
||||||
#### 8.2.1 Adaptive Recognition Systems
|
#### 8.2.1. Adaptive Recognition Systems
|
||||||
|
|
||||||
**Emerging Recognition Opportunities:**
|
**Emerging Recognition Opportunities:**
|
||||||
- Regular evaluation of community needs and new types of contributions that merit recognition
|
- Regular evaluation of community needs and new types of contributions that merit recognition
|
||||||
@@ -377,43 +377,43 @@ Nomination form can be found at https://forms.nhcarrigan.com/form/wksk-NuR3HBuov
|
|||||||
- Partnership development with external organisations to expand recognition opportunities and resources
|
- Partnership development with external organisations to expand recognition opportunities and resources
|
||||||
|
|
||||||
**Long-Term Program Sustainability:**
|
**Long-Term Program Sustainability:**
|
||||||
- Planning for recognition program continuity during leadership transitions and community growth
|
- Planning for recognition programme continuity during leadership transitions and community growth
|
||||||
- Resource allocation and volunteer development to support ongoing recognition activities
|
- Resource allocation and volunteer development to support ongoing recognition activities
|
||||||
- Documentation and knowledge preservation to maintain recognition program quality and consistency
|
- Documentation and knowledge preservation to maintain recognition programme quality and consistency
|
||||||
- Strategic planning for recognition program expansion and enhancement as community evolves
|
- Strategic planning for recognition programme expansion and enhancement as community evolves
|
||||||
|
|
||||||
## 9. Policy Implementation and Review
|
## 9. Policy Implementation and Review
|
||||||
|
|
||||||
### 9.1 Regular Review and Enhancement
|
### 9.1. Regular Review and Enhancement
|
||||||
|
|
||||||
#### 9.1.1 Continuous Improvement Process
|
#### 9.1.1. Continuous Improvement Process
|
||||||
|
|
||||||
**Monthly Program Assessment:**
|
**Monthly Program Assessment:**
|
||||||
- Recognition program effectiveness evaluation and participant satisfaction assessment
|
- Recognition programme effectiveness evaluation and participant satisfaction assessment
|
||||||
- Recognition distribution analysis to ensure equity and inclusive representation
|
- Recognition distribution analysis to ensure equity and inclusive representation
|
||||||
- Community feedback integration and program adjustment based on member input
|
- Community feedback integration and programme adjustment based on member input
|
||||||
- Volunteer appreciation program evaluation and enhancement planning
|
- Volunteer appreciation programme evaluation and enhancement planning
|
||||||
|
|
||||||
**Annual Comprehensive Review:**
|
**Annual Comprehensive Review:**
|
||||||
- Community-wide recognition program impact assessment and satisfaction evaluation
|
- Community-wide recognition programme impact assessment and satisfaction evaluation
|
||||||
- Recognition criteria and selection process review for effectiveness and fairness
|
- Recognition criteria and selection process review for effectiveness and fairness
|
||||||
- Accessibility and inclusion evaluation with improvement planning and implementation
|
- Accessibility and inclusion evaluation with improvement planning and implementation
|
||||||
- Strategic planning for recognition program expansion and innovation
|
- Strategic planning for recognition programme expansion and innovation
|
||||||
|
|
||||||
### 9.2 Community Celebration and Recognition Culture
|
### 9.2. Community Celebration and Recognition Culture
|
||||||
|
|
||||||
#### 9.2.1 Culture Development and Reinforcement
|
#### 9.2.1. Culture Development and Reinforcement
|
||||||
|
|
||||||
**Recognition Culture Promotion:**
|
**Recognition Culture Promotion:**
|
||||||
- Community education about the importance and impact of appreciation and recognition
|
- Community education about the importance and impact of appreciation and recognition
|
||||||
- Peer-to-peer recognition encouragement and facilitation
|
- Peer-to-peer recognition encouragement and facilitation
|
||||||
- Leadership modeling of appreciation and recognition practices
|
- Leadership modelling of appreciation and recognition practices
|
||||||
- Integration of recognition and appreciation into regular community activities and interactions
|
- Integration of recognition and appreciation into regular community activities and interactions
|
||||||
|
|
||||||
**Long-Term Community Impact:**
|
**Long-Term Community Impact:**
|
||||||
- Recognition program contribution to overall community health and member satisfaction
|
- Recognition programme contribution to overall community health and member satisfaction
|
||||||
- Appreciation culture development and maintenance as community grows and evolves
|
- Appreciation culture development and maintenance as community grows and evolves
|
||||||
- Recognition program role in member retention and continued positive community engagement
|
- Recognition programme role in member retention and continued positive community engagement
|
||||||
- Community reputation enhancement through recognition of excellence and positive contribution
|
- Community reputation enhancement through recognition of excellence and positive contribution
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -426,4 +426,4 @@ Through this Policy, we pledge to maintain systems that celebrate diverse contri
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Community Recognition and Appreciation Policy was created on 15 September 2025. For questions about recognition programs or to nominate community members for appreciation, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
*This Community Recognition and Appreciation Policy provides comprehensive information about recognition programmes. For questions about recognition programmes or to nominate community members for appreciation, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|||||||
@@ -2,13 +2,21 @@
|
|||||||
title: Contributing Documentation
|
title: Contributing Documentation
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1. Scope and General Contribution Guidelines
|
**ESTABLISHING CONTRIBUTION GUIDELINES AND REQUIREMENTS FOR ALL PROJECTS**
|
||||||
|
|
||||||
### 1.1 Overview
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
This document outlines the general guidelines for contributing to our projects. It serves as a high-level framework for all contributors, whether you're submitting code, documentation, or other forms of contribution.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
### 1.2 Project-Specific Instructions
|
This Contributing Documentation (hereinafter referred to as "the Guidelines") establishes mandatory guidelines, procedures, and requirements for all contributions to projects maintained by our organisation. These Guidelines operate within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Contributor Covenant, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
These Guidelines apply to all forms of contribution, including but not limited to code, documentation, artwork, design, and other materials submitted to any project maintained by our organisation. All contributors, regardless of status or experience level, are required to comply with these Guidelines.
|
||||||
|
|
||||||
|
**IMPORTANT: Failure to comply with these Guidelines may result in rejection of contributions, requests for modification, or other appropriate actions as determined by project maintainers.**
|
||||||
|
|
||||||
|
### 1.3. Project-Specific Instructions
|
||||||
|
|
||||||
While these guidelines apply broadly, individual projects may have unique requirements or processes. Always refer to the specific project's documentation for:
|
While these guidelines apply broadly, individual projects may have unique requirements or processes. Always refer to the specific project's documentation for:
|
||||||
|
|
||||||
@@ -20,151 +28,118 @@ While these guidelines apply broadly, individual projects may have unique requir
|
|||||||
|
|
||||||
In case of any discrepancy between this document and project-specific guidelines, the project-specific instructions take precedence.
|
In case of any discrepancy between this document and project-specific guidelines, the project-specific instructions take precedence.
|
||||||
|
|
||||||
### 1.3 Commit Signing Requirements
|
### 1.4. Commit Signing Requirements
|
||||||
|
|
||||||
All commits must be cryptographically signed using either GPG or SSH. This requirement serves to verify the authenticity and integrity of your contributions.
|
All commits must be cryptographically signed using either GPG or SSH. This requirement serves to verify the authenticity and integrity of your contributions.
|
||||||
|
|
||||||
- For GPG signing, ensure your GPG key is associated with your GitHub or Codeberg account.
|
- For GPG signing, ensure your GPG key is associated with your Github or NHCarrigan Git account.
|
||||||
- For SSH signing, use a key linked to your GitHub or Codeberg account.
|
- For SSH signing, use a key linked to your Github or NHCarrigan Git account.
|
||||||
|
|
||||||
By signing your commit, you are certifying that:
|
By signing your commit, you are certifying that:
|
||||||
|
|
||||||
- The commit adheres to our [Contributor Covenant](/covenant.md)
|
- The commit adheres to our [Contributor Covenant](/dev/covenant)
|
||||||
- You have the right to submit the contribution under our project license.
|
- You have the right to submit the contribution under our project license.
|
||||||
- You understand and agree to our contribution terms.
|
- You understand and agree to our contribution terms.
|
||||||
|
|
||||||
### 1.4 Contributor Covenant
|
### 1.5. Contributor Covenant
|
||||||
|
|
||||||
All contributors are expected to adhere to our Contributor Covenant. The full text of the Contributor Covenant can be found in [its own document](/covenant.md).
|
All contributors are expected to adhere to our Contributor Covenant. The full text of the Contributor Covenant can be found in [its own document](/dev/covenant).
|
||||||
|
|
||||||
### 1.5 Licensing of Contributions
|
### 1.6. Licensing of Contributions
|
||||||
|
|
||||||
All contributions to our projects, including but not limited to code, documentation, artwork, and other materials, will be licensed under our global software license. By submitting a contribution, you are agreeing to license your work under the terms of this license.
|
All contributions to our projects, including but not limited to code, documentation, artwork, and other materials, will be licensed under our global software licence. By submitting a contribution, you are agreeing to license your work under the terms of this license.
|
||||||
|
|
||||||
- Our global software license: Naomi's Public License
|
- Our global software licence: Naomi's Public Licence
|
||||||
- Full text of the license: [License Page](/legal/license)
|
- Full text of the license: [License Page](/legal/license)
|
||||||
|
|
||||||
### 1.6 Intellectual Property
|
### 1.7. Intellectual Property
|
||||||
|
|
||||||
By contributing to our projects, you affirm that:
|
By contributing to our projects, you affirm that:
|
||||||
|
|
||||||
- You own the copyright to your contribution or have authorization from the copyright owner to submit it under our license.
|
- You own the copyright to your contribution or have authorisation from the copyright owner to submit it under our license.
|
||||||
- Your contribution does not infringe on any third-party intellectual property rights.
|
- Your contribution does not infringe on any third-party intellectual property rights.
|
||||||
- You grant us a perpetual, worldwide, non-exclusive, royalty-free license to use, modify, and distribute your contribution.
|
- You grant us a perpetual, worldwide, non-exclusive, royalty-free license to use, modify, and distribute your contribution.
|
||||||
|
|
||||||
### 1.7 Legal Compliance
|
### 1.8. Legal Compliance
|
||||||
|
|
||||||
Ensure all contributions comply with relevant laws and regulations, including export controls and data protection laws.
|
Ensure all contributions comply with relevant laws and regulations, including export controls and data protection laws.
|
||||||
|
|
||||||
### 1.8 Acceptance of Contributions
|
### 1.9. Acceptance of Contributions
|
||||||
|
|
||||||
While we appreciate all contributions, we reserve the right to reject any contribution that doesn't meet our standards or align with our project goals. The project maintainers have final say on the inclusion of any contribution.
|
While we appreciate all contributions, we reserve the right to reject any contribution that doesn't meet our standards or align with our project goals. The project maintainers have final say on the inclusion of any contribution.
|
||||||
|
|
||||||
## 2. Secrets Management
|
## 2. SECRETS MANAGEMENT
|
||||||
|
|
||||||
### 2.1 Overview
|
### 2.1. Overview
|
||||||
|
|
||||||
Proper management of secrets is crucial for maintaining the security and integrity of our projects. We use 1Password as our centralized secrets management solution. This section outlines our policies and procedures for handling secrets.
|
Proper management of secrets is crucial for maintaining the security and integrity of our projects. We use 1Password as our centralised secrets management solution. This section outlines our policies and procedures for handling secrets.
|
||||||
|
|
||||||
### 2.2 General Policy
|
### 2.2. General Policy
|
||||||
|
|
||||||
- Plain-text secrets should never be stored on personal machines, development environments, or our servers.
|
- Plain-text secrets should never be stored on personal machines, development environments, or our servers.
|
||||||
- All secrets should be stored and managed through 1Password.
|
- All secrets should be stored and managed through 1Password.
|
||||||
|
|
||||||
### 2.3 1Password Setup and Usage
|
### 2.3. 1Password Setup and Usage
|
||||||
|
|
||||||
To work with secrets locally, you must set up the 1Password CLI (Command Line Interface) and integrate it with your 1Password desktop application.
|
To work with secrets locally, you must set up the 1Password CLI (Command Line Interface) and integrate it with your 1Password desktop application.
|
||||||
|
|
||||||
#### 2.3.1 Setup Instructions
|
#### 2.3.1. Setup Instructions
|
||||||
|
|
||||||
- Install the 1Password desktop application if you haven't already.
|
- Install the 1Password desktop application if you haven't already.
|
||||||
- Install the 1Password CLI. Instructions can be found at: https://developer.1password.com/docs/cli/get-started/
|
- Install the 1Password CLI. Instructions can be found at: https://developer.1password.com/docs/cli/get-started/
|
||||||
- Authenticate the CLI with your 1Password account.
|
- Authenticate the CLI with your 1Password account.
|
||||||
- Configure your development environment to use the 1Password CLI for secret retrieval. https://developer.1password.com/docs/cli/secrets-environment-variables/
|
- Configure your development environment to use the 1Password CLI for secret retrieval. https://developer.1password.com/docs/cli/secrets-environment-variables/
|
||||||
|
|
||||||
#### 2.3.2 Best Practices
|
#### 2.3.2. Best Practices
|
||||||
|
|
||||||
- Use environment variables to store secrets retrieved from 1Password during runtime.
|
- Use environment variables to store secrets retrieved from 1Password during runtime.
|
||||||
- Never log or display secrets in any form.
|
- Never log or display secrets in any form.
|
||||||
- Rotate secrets regularly.
|
- Rotate secrets regularly.
|
||||||
|
|
||||||
### 2.4 Handling Secrets in Code
|
### 2.4. Handling Secrets in Code
|
||||||
|
|
||||||
- Development environment variables should be set in `dev.env` - changes to this file should generally be excluded from your contributions.
|
- Development environment variables should be set in `dev.env` - changes to this file should generally be excluded from your contributions.
|
||||||
- Use 1Password references instead of actual secret values in configuration files.
|
- Use 1Password references instead of actual secret values in configuration files.
|
||||||
|
|
||||||
## 3. Setting Up Your Development Environment
|
## 3. SETTING UP YOUR DEVELOPMENT ENVIRONMENT
|
||||||
|
|
||||||
### 3.1 Forking the Repository
|
### 3.1. Gaining a Contributor Account
|
||||||
|
|
||||||
1. Navigate to the original repository on Codeberg.
|
Contributor accounts are provided only to members of our team. If you wish to join our volunteer team, please [apply](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8) for our Technical Contributor position.
|
||||||
2. Click the "Fork" button in the upper right corner of the page.
|
|
||||||
3. Select your account as the destination for the fork.
|
|
||||||
4. Wait for Codeberg to create a copy of the repository in your account.
|
|
||||||
|
|
||||||
### 3.2 Cloning Your Fork
|
Once accepted, you will be granted credentials as part of your onboarding.
|
||||||
|
|
||||||
1. Go to your forked repository on Codeberg.
|
### 3.2. Cloning A Project
|
||||||
2. Click the "Code" button and copy the URL (HTTPS or SSH, depending on your setup).
|
|
||||||
|
1. Go to repository on NHCarrigan's Git instance.
|
||||||
|
2. Click the "Code" button and copy the HTTPS URL.
|
||||||
3. Open your terminal or command prompt.
|
3. Open your terminal or command prompt.
|
||||||
4. Navigate to the directory where you want to store the project.
|
4. Navigate to the directory where you want to store the project.
|
||||||
5. Run the following command, replacing `<url>` with the URL you copied:
|
5. Run the following command, replacing `<url>` with the URL you copied:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
git clone <url>
|
git clone <url>
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Enter your GitHub credentials if prompted.
|
6. Enter your Git credentials if prompted.
|
||||||
|
|
||||||
### 3.3 Setting Up the Upstream Remote
|
### 3.3. Keeping Your Clone Up-to-Date
|
||||||
|
|
||||||
Adding the original repository as an upstream remote allows you to easily keep your fork up-to-date.
|
Regularly update your clone to incorporate changes from the upstream repository:
|
||||||
|
|
||||||
1. Change into the project directory:
|
1. Check out the main branch:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
cd <project-name>
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Add the upstream remote:
|
|
||||||
|
|
||||||
```
|
|
||||||
git remote add upstream <original-repository-url>
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `<original-repository-url>` with the **git** URL of the original repository.
|
|
||||||
|
|
||||||
3. Verify the new remote:
|
|
||||||
|
|
||||||
```
|
|
||||||
git remote -v
|
|
||||||
```
|
|
||||||
|
|
||||||
You should see entries for both `origin` (your fork) and `upstream`.
|
|
||||||
|
|
||||||
### 3.4 Keeping Your Fork Up-to-Date
|
|
||||||
|
|
||||||
Regularly update your fork to incorporate changes from the upstream repository:
|
|
||||||
|
|
||||||
1. Fetch the branches and commits from the upstream repository:
|
|
||||||
|
|
||||||
```
|
|
||||||
git fetch upstream
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Check out your fork's local main branch:
|
|
||||||
|
|
||||||
```
|
|
||||||
git checkout main
|
git checkout main
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Merge changes from upstream/main into your local main branch:
|
2. Pull changes from upstream to your local clone:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
git merge upstream/main
|
git pull
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.5 Troubleshooting
|
### 3.4. Troubleshooting
|
||||||
|
|
||||||
If you encounter any issues during setup:
|
If you encounter any issues during setup:
|
||||||
|
|
||||||
@@ -172,28 +147,28 @@ If you encounter any issues during setup:
|
|||||||
2. Search for similar issues in the project's issue tracker.
|
2. Search for similar issues in the project's issue tracker.
|
||||||
3. If the problem persists, open a new issue with detailed information about the problem and steps to reproduce it.
|
3. If the problem persists, open a new issue with detailed information about the problem and steps to reproduce it.
|
||||||
|
|
||||||
You can also reach out to us on our forum: https://forum.nhcarrigan.com
|
You can also reach out to us in our Discord community: https://chat.nhcarrigan.com
|
||||||
|
|
||||||
## 4. Claiming an Issue
|
## 4. CLAIMING AN ISSUE
|
||||||
|
|
||||||
### 4.1 Finding an Issue
|
### 4.1. Finding an Issue
|
||||||
|
|
||||||
1. Navigate to the project's issue tracker.
|
1. Navigate to the project's issue tracker.
|
||||||
2. Browse open issues or use filters to find tasks that interest you.
|
2. Browse open issues or use filters to find tasks that interest you.
|
||||||
3. Read the issue description thoroughly to understand the requirements and context.
|
3. Read the issue description thoroughly to understand the requirements and context.
|
||||||
|
|
||||||
### 4.2 Expressing Interest
|
### 4.2. Expressing Interest
|
||||||
|
|
||||||
1. If you find an issue you'd like to work on, comment on the issue expressing your interest.
|
1. If you find an issue you'd like to work on, comment on the issue expressing your interest.
|
||||||
2. Example comment: "I'm interested in working on this issue. May I be assigned to it?"
|
2. Example comment: "I'm interested in working on this issue. May I be assigned to it?"
|
||||||
3. Wait for a project maintainer to respond and potentially assign the issue to you.
|
3. Wait for a project maintainer to respond and potentially assign the issue to you.
|
||||||
|
|
||||||
### 4.3 Issue Assignment
|
### 4.3. Issue Assignment
|
||||||
|
|
||||||
- Project maintainers will assign issues based on the order of interest and the contributor's experience level.
|
- Project maintainers will assign issues based on the order of interest and the contributor's experience level.
|
||||||
- Once assigned, you'll see your username in the "Assignees" section of the issue.
|
- Once assigned, you'll see your username in the "Assignees" section of the issue.
|
||||||
|
|
||||||
### 4.4 Already Assigned Issues
|
### 4.4. Already Assigned Issues
|
||||||
|
|
||||||
If an issue is already assigned:
|
If an issue is already assigned:
|
||||||
|
|
||||||
@@ -204,32 +179,32 @@ If an issue is already assigned:
|
|||||||
|
|
||||||
We encourage collaboration and pair programming on complex issues!
|
We encourage collaboration and pair programming on complex issues!
|
||||||
|
|
||||||
### 4.5 Working on the Issue
|
### 4.5. Working on the Issue
|
||||||
|
|
||||||
1. Once assigned, create a new branch in your fork for this specific issue.
|
1. Once assigned, create a new branch in the project for this specific issue.
|
||||||
2. Use a descriptive branch name, e.g., `fix/issue-123-button-alignment`.
|
2. Use a descriptive branch name, e.g., `fix/issue-123-button-alignment`.
|
||||||
3. Make your changes, committing regularly with clear, concise commit messages.
|
3. Make your changes, committing regularly with clear, concise commit messages.
|
||||||
4. Push your changes to your fork.
|
4. Push your changes to your branch.
|
||||||
5. Open a pull request when ready for review (see Pull Request Guidelines in section [X]).
|
5. Open a pull request when ready for review (see Pull Request Guidelines in section [X]).
|
||||||
|
|
||||||
### 4.6 Keeping the Community Updated
|
### 4.6. Keeping the Community Updated
|
||||||
|
|
||||||
1. Provide regular updates on your progress in the issue comments.
|
1. Provide regular updates on your progress in the issue comments.
|
||||||
2. If you encounter obstacles, don't hesitate to ask for help in the issue thread.
|
2. If you encounter obstacles, don't hesitate to ask for help in the issue thread.
|
||||||
3. If you need to step away from an issue, please let us know so it can be reassigned if necessary.
|
3. If you need to step away from an issue, please let us know so it can be reassigned if necessary.
|
||||||
|
|
||||||
### 4.7 Time Management
|
### 4.7. Time Management
|
||||||
|
|
||||||
- Try to start working on the issue within a few days of assignment.
|
- Try to start working on the issue within a few days of assignment.
|
||||||
- If you haven't made progress within a week, the issue may be unassigned to keep the project moving forward.
|
- If you haven't made progress within a week, the issue may be unassigned to keep the project moving forward.
|
||||||
- If you need more time, communicate this in the issue comments.
|
- If you need more time, communicate this in the issue comments.
|
||||||
|
|
||||||
### 4.8 Multiple Issues
|
### 4.8. Multiple Issues
|
||||||
|
|
||||||
- We encourage focusing on one issue at a time to ensure quality and timely completion.
|
- We encourage focusing on one issue at a time to ensure quality and timely completion.
|
||||||
- If you want to work on multiple issues, please complete one before requesting assignment to another.
|
- If you want to work on multiple issues, please complete one before requesting assignment to another.
|
||||||
|
|
||||||
### 4.9 Issue Labels
|
### 4.9. Issue Labels
|
||||||
|
|
||||||
Pay attention to issue labels for additional context:
|
Pay attention to issue labels for additional context:
|
||||||
|
|
||||||
@@ -237,27 +212,27 @@ Pay attention to issue labels for additional context:
|
|||||||
- `help wanted`: Issues where we're actively seeking community help.
|
- `help wanted`: Issues where we're actively seeking community help.
|
||||||
- `staff only`: Issue that will require staff attention.
|
- `staff only`: Issue that will require staff attention.
|
||||||
|
|
||||||
### 4.10 Respectful Communication
|
### 4.10. Respectful Communication
|
||||||
|
|
||||||
- Always be courteous and professional in issue discussions.
|
- Always be courteous and professional in issue discussions.
|
||||||
- Respect the decisions of project maintainers regarding issue assignments and priorities.
|
- Respect the decisions of project maintainers regarding issue assignments and priorities.
|
||||||
- If you disagree with something, express your thoughts constructively and be open to feedback.
|
- If you disagree with something, express your thoughts constructively and be open to feedback.
|
||||||
|
|
||||||
## 5. Working on Your Issue
|
## 5. WORKING ON YOUR ISSUE
|
||||||
|
|
||||||
### 5.1 Updating Your Fork
|
### 5.1. Updating Your Clone
|
||||||
|
|
||||||
Before starting work, ensure your forked version is up to date with the original repository. If you've set up the `upstream` remote as mentioned in Section 3, follow these steps:
|
Before starting work, ensure your clone is up to date with the original repository.
|
||||||
|
|
||||||
1. Open your terminal and navigate to your project's root directory.
|
1. Open your terminal and navigate to your project's root directory.
|
||||||
2. Run the following commands:
|
2. Run the following commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git fetch upstream
|
git checkout main
|
||||||
git merge upstream/main
|
git pull
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5.2 Creating a New Branch
|
### 5.2. Creating a New Branch
|
||||||
|
|
||||||
Always create a new branch for your work:
|
Always create a new branch for your work:
|
||||||
|
|
||||||
@@ -278,17 +253,17 @@ Always create a new branch for your work:
|
|||||||
- `fix/resolve-memory-leak`
|
- `fix/resolve-memory-leak`
|
||||||
- `docs/update-api-endpoints`
|
- `docs/update-api-endpoints`
|
||||||
|
|
||||||
### 5.3 Making Changes
|
### 5.3. Making Changes
|
||||||
|
|
||||||
1. Make your code changes, following the project's coding standards and guidelines.
|
1. Make your code changes, following the project's coding standards and guidelines.
|
||||||
2. Regularly commit your changes with clear, concise messages.
|
2. Regularly commit your changes with clear, concise messages.
|
||||||
3. Push your changes to your fork periodically:
|
3. Push your changes to your branch periodically:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git push origin <branchname>
|
git push origin <branchname>
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5.4 Committing Changes
|
### 5.4. Committing Changes
|
||||||
|
|
||||||
When you're ready to commit your changes:
|
When you're ready to commit your changes:
|
||||||
|
|
||||||
@@ -310,7 +285,7 @@ When you're ready to commit your changes:
|
|||||||
git commit
|
git commit
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5.5 Commit Message Guidelines
|
### 5.5. Commit Message Guidelines
|
||||||
|
|
||||||
- Follow Conventional Commit standards: `type(scope): description` such as `docs: update contributing guidelines`.
|
- Follow Conventional Commit standards: `type(scope): description` such as `docs: update contributing guidelines`.
|
||||||
- Use the present tense ("Add feature" not "Added feature")
|
- Use the present tense ("Add feature" not "Added feature")
|
||||||
@@ -327,7 +302,7 @@ feat: add user authentication system
|
|||||||
Implement JWT-based authentication for API endpoints.
|
Implement JWT-based authentication for API endpoints.
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5.7 Testing Your Changes
|
### 5.7. Testing Your Changes
|
||||||
|
|
||||||
- Run the linter to ensure your code complies with [our style guidelines](/dev/style).
|
- Run the linter to ensure your code complies with [our style guidelines](/dev/style).
|
||||||
|
|
||||||
@@ -343,12 +318,12 @@ Implement JWT-based authentication for API endpoints.
|
|||||||
|
|
||||||
- Add new tests for your changes if applicable.
|
- Add new tests for your changes if applicable.
|
||||||
|
|
||||||
### 5.8 Documentation
|
### 5.8. Documentation
|
||||||
|
|
||||||
- Update relevant documentation to reflect your changes.
|
- Update relevant documentation to reflect your changes.
|
||||||
- If you've added new features, include appropriate documentation.
|
- If you've added new features, include appropriate documentation.
|
||||||
|
|
||||||
### 5.9 Preparing for Pull Request
|
### 5.9. Preparing for Pull Request
|
||||||
|
|
||||||
Before submitting a pull request:
|
Before submitting a pull request:
|
||||||
|
|
||||||
@@ -357,32 +332,32 @@ Before submitting a pull request:
|
|||||||
1. Ensure all tests pass.
|
1. Ensure all tests pass.
|
||||||
1. Review your changes and commit history.
|
1. Review your changes and commit history.
|
||||||
|
|
||||||
If you're unsure about any part of the process or need help, don't hesitate to ask in our [forum](https://forum.nhcarrigan.com). Our community is here to support you!
|
If you're unsure about any part of the process or need help, don't hesitate to ask in our [Discord community](https://chat.nhcarrigan.com). Our community is here to support you!
|
||||||
|
|
||||||
## 6. Submitting a Pull Request
|
## 6. SUBMITTING A PULL REQUEST
|
||||||
|
|
||||||
### 6.1 Pushing Your Changes
|
### 6.1. Pushing Your Changes
|
||||||
|
|
||||||
1. Push your changes to your forked repository:
|
1. Push your changes to the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git push -u origin <branchname>
|
git push -u origin <branchname>
|
||||||
```
|
```
|
||||||
|
|
||||||
- `-u` sets the upstream, linking your local branch to the remote branch
|
- `-u` sets the upstream, linking your local branch to the remote branch
|
||||||
- `origin` specifies your forked repository as the destination
|
- `origin` specifies the project repository as the destination
|
||||||
- `<branchname>` is the name of your local branch
|
- `<branchname>` is the name of your local branch
|
||||||
|
|
||||||
2. Ensure the push is successful and your changes appear in your forked repository on Codeberg.
|
2. Ensure the push is successful and your changes appear in the repository on NHCarrigan's Git instance.
|
||||||
|
|
||||||
### 6.2 Creating the Pull Request
|
### 6.2. Creating the Pull Request
|
||||||
|
|
||||||
1. Navigate to your forked repository on Codeberg.
|
1. Navigate to the repository on NHCarrigan's Git instance.
|
||||||
2. You should see a prompt to create a pull request for your recently pushed branch. If not, click on the "Pull requests" tab and then the "New pull request" button.
|
2. You should see a prompt to create a pull request for your recently pushed branch. If not, click on the "Pull requests" tab and then the "New pull request" button.
|
||||||
3. Ensure the base repository is the original project repository and the base branch is `main`.
|
3. Ensure the base repository is the original project repository and the base branch is `main`.
|
||||||
4. Select your fork as the head repository and your recently pushed branch as the compare branch.
|
4. Select the project as the head repository and your recently pushed branch as the compare branch.
|
||||||
|
|
||||||
### 6.3 Filling Out the Pull Request
|
### 6.3. Filling Out the Pull Request
|
||||||
|
|
||||||
1. Change the title of your pull request to be a conventional commit message summarising all changes in that PR
|
1. Change the title of your pull request to be a conventional commit message summarising all changes in that PR
|
||||||
2. Fill out the pull request description with as much information as possible. This typically includes:
|
2. Fill out the pull request description with as much information as possible. This typically includes:
|
||||||
@@ -392,24 +367,24 @@ git push -u origin <branchname>
|
|||||||
3. Fill out the rest of the pull request form *completely*.
|
3. Fill out the rest of the pull request form *completely*.
|
||||||
4. If your changes include visual elements, consider adding screenshots or GIFs to illustrate the modifications.
|
4. If your changes include visual elements, consider adding screenshots or GIFs to illustrate the modifications.
|
||||||
|
|
||||||
### 6.4 Pull Request Best Practices
|
### 6.4. Pull Request Best Practices
|
||||||
|
|
||||||
- Ensure your PR addresses only one issue or adds one feature. If you have made multiple unrelated changes, consider breaking them into separate pull requests.
|
- Ensure your PR addresses only one issue or adds one feature. If you have made multiple unrelated changes, consider breaking them into separate pull requests.
|
||||||
- Double-check that all tests pass and there are no conflicts with the base branch.
|
- Double-check that all tests pass and there are no conflicts with the base branch.
|
||||||
- If your PR is a work in progress, mark it as a draft pull request.
|
- If your PR is a work in progress, mark it as a draft pull request.
|
||||||
|
|
||||||
### 6.5 After Submitting
|
### 6.5. After Submitting
|
||||||
|
|
||||||
- Keep an eye on your pull request for any comments, requests for changes, or approval.
|
- Keep an eye on your pull request for any comments, requests for changes, or approval.
|
||||||
- Be prepared to make additional commits to your branch if changes are requested.
|
- Be prepared to make additional commits to your branch if changes are requested.
|
||||||
|
|
||||||
### 6.6 Updating Your Pull Request
|
### 6.6. Updating Your Pull Request
|
||||||
|
|
||||||
If you need to make changes to your pull request:
|
If you need to make changes to your pull request:
|
||||||
|
|
||||||
1. Make the required changes in your local branch.
|
1. Make the required changes in your local branch.
|
||||||
2. Commit the changes.
|
2. Commit the changes.
|
||||||
3. Push the new commits to your fork:
|
3. Push the new commits to your branch:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git push origin <branchname>
|
git push origin <branchname>
|
||||||
@@ -417,28 +392,28 @@ If you need to make changes to your pull request:
|
|||||||
|
|
||||||
4. The pull request will automatically update with your new commits.
|
4. The pull request will automatically update with your new commits.
|
||||||
|
|
||||||
### 6.7 Pull Request Etiquette
|
### 6.7. Pull Request Etiquette
|
||||||
|
|
||||||
- Be patient. Maintainers are often managing multiple priorities.
|
- Be patient. Maintainers are often managing multiple priorities.
|
||||||
- Be open to feedback and willing to make changes.
|
- Be open to feedback and willing to make changes.
|
||||||
- Respond promptly to any questions or requests from reviewers.
|
- Respond promptly to any questions or requests from reviewers.
|
||||||
- If there's a delay in your ability to respond or make requested changes, leave a comment explaining the situation.
|
- If there's a delay in your ability to respond or make requested changes, leave a comment explaining the situation.
|
||||||
|
|
||||||
### 6.8 Merging and Closing
|
### 6.8. Merging and Closing
|
||||||
|
|
||||||
- Once your pull request is approved, a maintainer will merge it into the main project.
|
- Once your pull request is approved, a maintainer will merge it into the main project.
|
||||||
- After merging, you can delete your branch from your fork if you won't be using it anymore.
|
- After merging, you can delete your branch from the repository if you won't be using it anymore.
|
||||||
- Celebrate your contribution to the project!
|
- Celebrate your contribution to the project!
|
||||||
|
|
||||||
## 7. Pull Request Reviews
|
## 7. PULL REQUEST REVIEWS
|
||||||
|
|
||||||
### 7.1 Review Process Overview
|
### 7.1. Review Process Overview
|
||||||
|
|
||||||
- All pull requests require at least one approved review before merging.
|
- All pull requests require at least one approved review before merging.
|
||||||
- Reviews are primarily conducted by Naomi, but some projects may have additional reviewers.
|
- Reviews are primarily conducted by Naomi, but some projects may have additional reviewers.
|
||||||
- The review process helps maintain code quality, consistency, and project standards.
|
- The review process helps maintain code quality, consistency, and project standards.
|
||||||
|
|
||||||
### 7.2 What Reviewers Look For
|
### 7.2. What Reviewers Look For
|
||||||
|
|
||||||
Reviewers typically assess the following aspects:
|
Reviewers typically assess the following aspects:
|
||||||
|
|
||||||
@@ -449,13 +424,13 @@ Reviewers typically assess the following aspects:
|
|||||||
5. Adherence to project-specific guidelines
|
5. Adherence to project-specific guidelines
|
||||||
6. Potential impact on existing features or performance
|
6. Potential impact on existing features or performance
|
||||||
|
|
||||||
### 7.3 Types of Review Outcomes
|
### 7.3. Types of Review Outcomes
|
||||||
|
|
||||||
1. **Approved**: Your pull request is ready to be merged.
|
1. **Approved**: Your pull request is ready to be merged.
|
||||||
2. **Changes Requested**: Modifications or additional information is needed before approval.
|
2. **Changes Requested**: Modifications or additional information is needed before approval.
|
||||||
3. **Commented**: The reviewer has provided feedback but hasn't explicitly approved or requested changes.
|
3. **Commented**: The reviewer has provided feedback but hasn't explicitly approved or requested changes.
|
||||||
|
|
||||||
### 7.4 Responding to Review Feedback
|
### 7.4. Responding to Review Feedback
|
||||||
|
|
||||||
If changes are requested:
|
If changes are requested:
|
||||||
|
|
||||||
@@ -465,31 +440,31 @@ If changes are requested:
|
|||||||
4. Commit and push the changes to update your pull request.
|
4. Commit and push the changes to update your pull request.
|
||||||
5. Respond to each comment, explaining how you addressed the feedback or why you chose a different approach.
|
5. Respond to each comment, explaining how you addressed the feedback or why you chose a different approach.
|
||||||
|
|
||||||
### 7.5 Best Practices for Handling Reviews
|
### 7.5. Best Practices for Handling Reviews
|
||||||
|
|
||||||
- Respond promptly to review comments (ideally within a few days).
|
- Respond promptly to review comments (ideally within a few days).
|
||||||
- Be open to constructive criticism and willing to make changes.
|
- Be open to constructive criticism and willing to make changes.
|
||||||
- If you disagree with a suggestion, explain your reasoning politely and be open to discussion.
|
- If you disagree with a suggestion, explain your reasoning politely and be open to discussion.
|
||||||
- Use the review process as a learning opportunity to improve your coding skills.
|
- Use the review process as a learning opportunity to improve your coding skills.
|
||||||
|
|
||||||
### 7.6 Timelines and Expectations
|
### 7.6. Timelines and Expectations
|
||||||
|
|
||||||
- We strive to review pull requests as quickly as possible, typically within a week.
|
- We strive to review pull requests as quickly as possible, typically within a week.
|
||||||
- If your pull request requires changes, please address them promptly.
|
- If your pull request requires changes, please address them promptly.
|
||||||
- Pull requests with outstanding change requests and no activity for a week may be closed as stale.
|
- Pull requests with outstanding change requests and no activity for a week may be closed as stale.
|
||||||
- If you need more time to address changes, communicate this in the pull request comments to prevent your contribution from being closed.
|
- If you need more time to address changes, communicate this in the pull request comments to prevent your contribution from being closed.
|
||||||
|
|
||||||
### 7.7 Multiple Iterations
|
### 7.7. Multiple Iterations
|
||||||
|
|
||||||
- Complex changes may require multiple rounds of reviews and revisions.
|
- Complex changes may require multiple rounds of reviews and revisions.
|
||||||
- Stay engaged throughout the process and be patient if additional iterations are needed.
|
- Stay engaged throughout the process and be patient if additional iterations are needed.
|
||||||
|
|
||||||
### 7.8 Learning from the Review Process
|
### 7.8. Learning from the Review Process
|
||||||
|
|
||||||
- Take note of common feedback to improve future contributions.
|
- Take note of common feedback to improve future contributions.
|
||||||
- Consider reviewing other pull requests to gain insights into the project's standards and practices.
|
- Consider reviewing other pull requests to gain insights into the project's standards and practices.
|
||||||
|
|
||||||
### 7.9 After Approval
|
### 7.9. After Approval
|
||||||
|
|
||||||
Once your pull request is approved:
|
Once your pull request is approved:
|
||||||
|
|
||||||
@@ -498,11 +473,11 @@ Once your pull request is approved:
|
|||||||
|
|
||||||
Thank you for providing that section. I'll expand and improve it to make it more comprehensive and encourage a wider range of contributions. Here's an enhanced version:
|
Thank you for providing that section. I'll expand and improve it to make it more comprehensive and encourage a wider range of contributions. Here's an enhanced version:
|
||||||
|
|
||||||
## 8. Other Contributions
|
## 8. OTHER CONTRIBUTIONS
|
||||||
|
|
||||||
We value all types of contributions, not just code. There are many ways to contribute to our project, regardless of your technical experience or comfort level with the codebase. Here are several ways you can make a meaningful impact:
|
We value all types of contributions, not just code. There are many ways to contribute to our project, regardless of your technical experience or comfort level with the codebase. Here are several ways you can make a meaningful impact:
|
||||||
|
|
||||||
### 8.1 Documentation Updates
|
### 8.1. Documentation Updates
|
||||||
|
|
||||||
Clear and accurate documentation is crucial for any project. You can help by:
|
Clear and accurate documentation is crucial for any project. You can help by:
|
||||||
|
|
||||||
@@ -511,7 +486,7 @@ Clear and accurate documentation is crucial for any project. You can help by:
|
|||||||
- Creating new documentation for undocumented features
|
- Creating new documentation for undocumented features
|
||||||
- Improving README files, API documentation, or user guides
|
- Improving README files, API documentation, or user guides
|
||||||
|
|
||||||
### 8.2 Feature Requests
|
### 8.2. Feature Requests
|
||||||
|
|
||||||
Your ideas can help shape the future of the project. To suggest a new feature:
|
Your ideas can help shape the future of the project. To suggest a new feature:
|
||||||
|
|
||||||
@@ -523,17 +498,17 @@ Your ideas can help shape the future of the project. To suggest a new feature:
|
|||||||
Consider discussing your idea in our community chat before creating an issue to gather initial feedback.
|
Consider discussing your idea in our community chat before creating an issue to gather initial feedback.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### 8.3 Bug Reports
|
### 8.3. Bug Reports
|
||||||
|
|
||||||
Identifying and reporting bugs is a valuable contribution. When reporting a bug:
|
Identifying and reporting bugs is a valuable contribution. When reporting a bug:
|
||||||
|
|
||||||
1. Search existing issues to avoid duplicates
|
1. Search existing issues to avoid duplicates
|
||||||
1. Provide a clear, concise description of the problem
|
1. Provide a clear, concise description of the problem
|
||||||
1. Include steps to reproduce the bug
|
1. Include steps to reproduce the bug
|
||||||
1. Describe the expected behavior and what actually happened
|
1. Describe the expected behaviour and what actually happened
|
||||||
1. If possible, include screenshots, error messages, or code samples
|
1. If possible, include screenshots, error messages, or code samples
|
||||||
|
|
||||||
### 8.4 User Support
|
### 8.4. User Support
|
||||||
|
|
||||||
Helping other users is a great way to contribute to the community:
|
Helping other users is a great way to contribute to the community:
|
||||||
|
|
||||||
@@ -542,7 +517,7 @@ Helping other users is a great way to contribute to the community:
|
|||||||
- Guide new users through common issues or setup processes
|
- Guide new users through common issues or setup processes
|
||||||
- Create tutorials or blog posts about using the project
|
- Create tutorials or blog posts about using the project
|
||||||
|
|
||||||
### 8.5 Design Contributions
|
### 8.5. Design Contributions
|
||||||
|
|
||||||
If you have design skills, you can contribute by:
|
If you have design skills, you can contribute by:
|
||||||
|
|
||||||
@@ -551,7 +526,7 @@ If you have design skills, you can contribute by:
|
|||||||
- Improving the overall user experience and accessibility
|
- Improving the overall user experience and accessibility
|
||||||
- Creating infographics or visual aids for documentation
|
- Creating infographics or visual aids for documentation
|
||||||
|
|
||||||
### 8.6 Testing and Quality Assurance
|
### 8.6. Testing and Quality Assurance
|
||||||
|
|
||||||
Help improve the project's stability by:
|
Help improve the project's stability by:
|
||||||
|
|
||||||
@@ -560,7 +535,7 @@ Help improve the project's stability by:
|
|||||||
- Writing or improving automated tests
|
- Writing or improving automated tests
|
||||||
- Identifying edge cases or potential security issues
|
- Identifying edge cases or potential security issues
|
||||||
|
|
||||||
### 8.7 Community Building
|
### 8.7. Community Building
|
||||||
|
|
||||||
Foster a welcoming and inclusive community by:
|
Foster a welcoming and inclusive community by:
|
||||||
|
|
||||||
@@ -569,7 +544,7 @@ Foster a welcoming and inclusive community by:
|
|||||||
- Promoting the project on social media or relevant forums
|
- Promoting the project on social media or relevant forums
|
||||||
- Helping to moderate community discussions
|
- Helping to moderate community discussions
|
||||||
|
|
||||||
### 8.8 Internationalization and Localization
|
### 8.8. Internationalization and Localization
|
||||||
|
|
||||||
Make the project accessible to a global audience:
|
Make the project accessible to a global audience:
|
||||||
|
|
||||||
@@ -577,7 +552,7 @@ Make the project accessible to a global audience:
|
|||||||
- Provide localized documentation
|
- Provide localized documentation
|
||||||
- Ensure the project supports multiple languages and cultures
|
- Ensure the project supports multiple languages and cultures
|
||||||
|
|
||||||
### 8.9 Code Reviews
|
### 8.9. Code Reviews
|
||||||
|
|
||||||
Even if you're not comfortable making code changes, you can:
|
Even if you're not comfortable making code changes, you can:
|
||||||
|
|
||||||
@@ -585,7 +560,7 @@ Even if you're not comfortable making code changes, you can:
|
|||||||
- Provide feedback on proposed features or bug fixes
|
- Provide feedback on proposed features or bug fixes
|
||||||
- Help ensure code style and convention consistency
|
- Help ensure code style and convention consistency
|
||||||
|
|
||||||
### 8.10 Fundraising and Sponsorship
|
### 8.10. Fundraising and Sponsorship
|
||||||
|
|
||||||
If you have connections or experience in this area:
|
If you have connections or experience in this area:
|
||||||
|
|
||||||
@@ -595,12 +570,46 @@ If you have connections or experience in this area:
|
|||||||
|
|
||||||
Or even make a donation yourself!
|
Or even make a donation yourself!
|
||||||
|
|
||||||
### 8.11 Mentoring
|
### 8.11. Mentoring
|
||||||
|
|
||||||
Share your knowledge and experience:
|
Share your knowledge and experience:
|
||||||
|
|
||||||
- Mentor new contributors
|
- Mentor new contributors
|
||||||
- Create learning resources for the project
|
- Create learning resources for the project
|
||||||
- Participate in or organize coding workshops related to the project
|
- Participate in or organise coding workshops related to the project
|
||||||
|
|
||||||
Remember, all contributions, big or small, are valuable to the project. Don't hesitate to get involved in any way you feel comfortable. If you have any questions about how to contribute or need help getting started, please reach out to us in our Discord server or through the project's communication channels.
|
Remember, all contributions, big or small, are valuable to the project. Don't hesitate to get involved in any way you feel comfortable. If you have any questions about how to contribute or need help getting started, please reach out to us in our Discord server or through the project's communication channels.
|
||||||
|
|
||||||
|
## 9. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 9.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 9.2. Contribution Guidelines Disclaimer
|
||||||
|
|
||||||
|
These Guidelines establish mandatory requirements for contributions. However, compliance with these Guidelines does not guarantee acceptance of contributions. Project maintainers reserve the right to:
|
||||||
|
|
||||||
|
- Reject contributions that comply with these Guidelines for other valid reasons
|
||||||
|
- Request modifications beyond the scope of these Guidelines
|
||||||
|
- Modify or update these Guidelines at any time without prior notice
|
||||||
|
- Interpret Guideline requirements in specific contexts as necessary
|
||||||
|
|
||||||
|
### 9.3. Technical Accuracy Disclaimer
|
||||||
|
|
||||||
|
While we strive to maintain accurate and current information in these Guidelines, technical standards, tooling, and best practices evolve continuously. Contributors are responsible for:
|
||||||
|
|
||||||
|
- Verifying current tool versions and compatibility
|
||||||
|
- Ensuring their development environment matches project requirements
|
||||||
|
- Adapting to updates in these Guidelines as they are published
|
||||||
|
- Consulting project-specific documentation for additional requirements
|
||||||
|
|
||||||
|
## 10. CONCLUSION
|
||||||
|
|
||||||
|
These Contributing Guidelines represent our commitment to maintaining high-quality, consistent, and legally compliant contributions across all projects. By adhering to these standards, contributors help ensure that our projects remain accessible, professional, and aligned with our organisational values and legal obligations.
|
||||||
|
|
||||||
|
All contributors are expected to familiarise themselves with and comply with the requirements set forth in these Guidelines. Questions about specific requirements or requests for clarification should be directed to project maintainers through appropriate communication channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about contribution requirements or to suggest improvements, please contact project maintainers through the designated channels outlined in our Contributor Covenant.*
|
||||||
|
|||||||
@@ -2,12 +2,12 @@
|
|||||||
title: Contributor Covenant
|
title: Contributor Covenant
|
||||||
---
|
---
|
||||||
|
|
||||||
Copyright (C) 2024 nhcarrigan and its contributors.
|
Copyright (C) 2024 NHCarrigan and its contributors.
|
||||||
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
license document, but changing it is not allowed.
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
## nhcarrigan Contributor Covenant 1.0
|
## NHCarrigan Contributor Covenant 1.0
|
||||||
|
|
||||||
By making a contribution to this project I certify that:
|
By making a contribution to this project I certify that:
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ By making a contribution to this project I certify that:
|
|||||||
I have the right to submit any code, documentation, or other content under the project's designated license.
|
I have the right to submit any code, documentation, or other content under the project's designated license.
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
If my contribution is based on previous work covered under an open source license, I have the right to submit that work with modifications under the project's license.
|
If my contribution is based on previous work covered under an open source licence, I have the right to submit that work with modifications under the project's license.
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Any contribution provided to me by another person for submission to this project has been done so with certification of points <code>a</code> through <code>d</code>, and I have not modified it.
|
Any contribution provided to me by another person for submission to this project has been done so with certification of points <code>a</code> through <code>d</code>, and I have not modified it.
|
||||||
@@ -31,12 +31,12 @@ By making a contribution to this project I certify that:
|
|||||||
I understand that my contributions may be logged publicly, and that moderation actions taken in response to Code of Conduct violations may be recorded in the community's public moderation log.
|
I understand that my contributions may be logged publicly, and that moderation actions taken in response to Code of Conduct violations may be recorded in the community's public moderation log.
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
|
I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed consistent with this project or the open source licence(s) involved.
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
I acknowledge that community leaders have the right and responsibility to remove, edit, or reject my contributions if they do not align with this certificate or the project's Code of Conduct.
|
I acknowledge that community leaders have the right and responsibility to remove, edit, or reject my contributions if they do not align with this certificate or the project's Code of Conduct.
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
I agree to release my contribution to nhcarrigan pursuant to the Terms of Service.
|
I agree to release my contribution to NHCarrigan pursuant to the Terms of Service.
|
||||||
</li>
|
</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|||||||
@@ -2,13 +2,34 @@
|
|||||||
title: Development Environment
|
title: Development Environment
|
||||||
---
|
---
|
||||||
|
|
||||||
This page documents Naomi's local development environment. The information here is provided to allow contributors to mirror the environment as closely as possible, ensuring the smoothest developer experience.
|
**DOCUMENTING DEVELOPMENT ENVIRONMENT SPECIFICATIONS AND CONFIGURATION REQUIREMENTS**
|
||||||
|
|
||||||
## 1. System Information
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
Naomi's local environment runs on the Arch Linux kernel.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
### 1.1. `hyfetch`
|
This Development Environment Documentation (hereinafter referred to as "the Documentation") provides technical specifications, configuration details, and environment setup information for development work on projects maintained by our organisation. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Contributor Covenant, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
|
This Documentation describes the primary development environment used by our organisation's lead developer. While contributors are not required to replicate this exact environment, this information is provided to facilitate:
|
||||||
|
|
||||||
|
- Understanding of the development context and tooling preferences
|
||||||
|
- Troubleshooting compatibility issues
|
||||||
|
- Achieving similar development experiences
|
||||||
|
- Ensuring consistency in development practices
|
||||||
|
|
||||||
|
**IMPORTANT: This Documentation is provided for informational purposes. Contributors may use any development environment that meets project requirements. Our organisation does not endorse or require specific tools, operating systems, or configurations beyond those necessary for project functionality.**
|
||||||
|
|
||||||
|
### 1.3. Disclaimer
|
||||||
|
|
||||||
|
The information contained in this Documentation reflects the personal preferences and configurations of individual developers. These configurations are not mandatory requirements for contributions. Our organisation does not guarantee that replicating these configurations will result in identical development experiences.
|
||||||
|
|
||||||
|
## 2. SYSTEM INFORMATION
|
||||||
|
|
||||||
|
The primary development environment runs on the Arch Linux kernel.
|
||||||
|
|
||||||
|
### 2.1. Hyfetch Diagnostic Report
|
||||||
|
|
||||||
This is the current diagnostic report from `hyfetch`.
|
This is the current diagnostic report from `hyfetch`.
|
||||||
|
|
||||||
@@ -75,11 +96,11 @@ Editor: Emacs 30.2
|
|||||||
└─Nano: 8.5
|
└─Nano: 8.5
|
||||||
```
|
```
|
||||||
|
|
||||||
## 2. Packages
|
## 3. PACKAGES
|
||||||
|
|
||||||
Naomi uses the following packages.
|
Naomi uses the following packages.
|
||||||
|
|
||||||
### 2.1. Foreign Packages
|
### 3.1. Foreign Packages
|
||||||
|
|
||||||
These packages come from unofficial repositories, such as the AUR. This list is generated with `yay -Qm`.
|
These packages come from unofficial repositories, such as the AUR. This list is generated with `yay -Qm`.
|
||||||
|
|
||||||
@@ -151,7 +172,7 @@ yay-debug 12.5.0-1
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### 2.2. Explicit Installations
|
### 3.2. Explicit Installations
|
||||||
|
|
||||||
These are all of the packages Naomi has specifically installed. This list is generated with `yay -Qe`.
|
These are all of the packages Naomi has specifically installed. This list is generated with `yay -Qe`.
|
||||||
|
|
||||||
@@ -345,7 +366,7 @@ zram-generator 1.2.1-1
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### 2.3. Pinned Packages
|
### 3.3. Pinned Packages
|
||||||
|
|
||||||
These packages have updates ignored, due to incompatibility issues. This list is generated with `grep "^IgnorePkg" /etc/pacman.conf`.
|
These packages have updates ignored, due to incompatibility issues. This list is generated with `grep "^IgnorePkg" /etc/pacman.conf`.
|
||||||
|
|
||||||
@@ -353,7 +374,7 @@ These packages have updates ignored, due to incompatibility issues. This list is
|
|||||||
IgnorePkg = sway
|
IgnorePkg = sway
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.4. All Packages
|
### 3.4. All Packages
|
||||||
|
|
||||||
This is a complete list of all packages on the machine. This list is generated with `yay -Q`.
|
This is a complete list of all packages on the machine. This list is generated with `yay -Q`.
|
||||||
|
|
||||||
@@ -1857,11 +1878,11 @@ zziplib 0.13.80-1
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## 3. Configuration
|
## 4. CONFIGURATION
|
||||||
|
|
||||||
Naomi's specific application configurations are noted here for posterity.
|
Naomi's specific application configurations are noted here for posterity.
|
||||||
|
|
||||||
### 3.1. `git`
|
### 4.1. Git Configuration
|
||||||
|
|
||||||
The most important thing to note is that Naomi signs her commits with her SSH key, not a GPG key.
|
The most important thing to note is that Naomi signs her commits with her SSH key, not a GPG key.
|
||||||
|
|
||||||
@@ -1886,7 +1907,7 @@ The most important thing to note is that Naomi signs her commits with her SSH ke
|
|||||||
helper = store
|
helper = store
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.2. `zsh`
|
### 4.2. Zsh Configuration
|
||||||
|
|
||||||
Naomi uses Oh My ZSH instead of bash.
|
Naomi uses Oh My ZSH instead of bash.
|
||||||
|
|
||||||
@@ -1997,7 +2018,7 @@ eval "$(starship init zsh)"
|
|||||||
source <(ng completion script)
|
source <(ng completion script)
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 3.2.1. `starship`
|
#### 4.2.1. Starship Configuration
|
||||||
|
|
||||||
Naomi uses `starship` to manage her customised shell prompt.
|
Naomi uses `starship` to manage her customised shell prompt.
|
||||||
|
|
||||||
@@ -2106,7 +2127,7 @@ command = "mommy -1 -s $status"
|
|||||||
when = true
|
when = true
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.3. `pacman`
|
### 4.3. Pacman Configuration
|
||||||
|
|
||||||
Naomi's package manager configuration.
|
Naomi's package manager configuration.
|
||||||
|
|
||||||
@@ -2135,7 +2156,7 @@ Include = /etc/pacman.d/chaotic-mirrorlist
|
|||||||
Include = /etc/pacman.d/mirrorlist
|
Include = /etc/pacman.d/mirrorlist
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.4 `sway`
|
### 4.4. Sway Configuration
|
||||||
|
|
||||||
```ini frame="code" title="~/.config/sway/config"
|
```ini frame="code" title="~/.config/sway/config"
|
||||||
set $mod Mod4
|
set $mod Mod4
|
||||||
@@ -2280,7 +2301,7 @@ bar {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 3.4.1. `swaylock`
|
#### 4.4.1. Swaylock Configuration
|
||||||
|
|
||||||
```ini frame="code" title="~/.config/swaylock/config"
|
```ini frame="code" title="~/.config/swaylock/config"
|
||||||
# Background image
|
# Background image
|
||||||
@@ -2296,7 +2317,7 @@ fade-in=0.2
|
|||||||
effect-blur=8x2
|
effect-blur=8x2
|
||||||
effect-vignette=0.5:0.5
|
effect-vignette=0.5:0.5
|
||||||
|
|
||||||
# Ring customization
|
# Ring customisation
|
||||||
indicator-radius=120
|
indicator-radius=120
|
||||||
indicator-thickness=20
|
indicator-thickness=20
|
||||||
indicator-idle-visible
|
indicator-idle-visible
|
||||||
@@ -2332,12 +2353,12 @@ text-clear-color=abfcec
|
|||||||
text-ver-color=abfcec
|
text-ver-color=abfcec
|
||||||
text-wrong-color=abfcec
|
text-wrong-color=abfcec
|
||||||
|
|
||||||
# Text customization
|
# Text customisation
|
||||||
font=OpenDyslexicMono
|
font=OpenDyslexicMono
|
||||||
font-size=24
|
font-size=24
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.5 Waybar
|
### 4.5. Waybar Configuration
|
||||||
|
|
||||||
These manage Naomi's waybar instance.
|
These manage Naomi's waybar instance.
|
||||||
|
|
||||||
@@ -2714,7 +2735,7 @@ echo "{\"text\":\"${text}\", \"tooltip\":\"${tooltip}\"}";
|
|||||||
#!/usr/bin/env sh
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
model=$(cat /proc/cpuinfo | grep 'model name' | head -n 1 | awk -F ': ' '{print $2}')
|
model=$(cat /proc/cpuinfo | grep 'model name' | head -n 1 | awk -F ': ' '{print $2}')
|
||||||
utilization=$(top -bn1 | awk '/^%Cpu/ {print 100 - $8}')
|
utilisation=$(top -bn1 | awk '/^%Cpu/ {print 100 - $8}')
|
||||||
freqlist=$(cat /proc/cpuinfo | grep "cpu MHz" | awk '{ print $4 }')
|
freqlist=$(cat /proc/cpuinfo | grep "cpu MHz" | awk '{ print $4 }')
|
||||||
maxfreq=$(cat /sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_max_freq | sed 's/...$//')
|
maxfreq=$(cat /sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_max_freq | sed 's/...$//')
|
||||||
frequency=$(echo $freqlist | tr ' ' '\n' | awk "{ sum+=\$1 } END {printf \"%.0f/$maxfreq MHz\", sum/NR}")
|
frequency=$(echo $freqlist | tr ' ' '\n' | awk "{ sum+=\$1 } END {printf \"%.0f/$maxfreq MHz\", sum/NR}")
|
||||||
@@ -2731,8 +2752,8 @@ eval_ico() {
|
|||||||
echo "${set_ico}" | jq -r --arg aky "$1" --arg avl "$map_ico" '.[$aky] | .[$avl]'
|
echo "${set_ico}" | jq -r --arg aky "$1" --arg avl "$map_ico" '.[$aky] | .[$avl]'
|
||||||
}
|
}
|
||||||
thermo=$(eval_ico thermo $temp)
|
thermo=$(eval_ico thermo $temp)
|
||||||
speedo=$(eval_ico util $utilization)
|
speedo=$(eval_ico util $utilisation)
|
||||||
echo "{\"text\":\"${thermo} ${temp}°C\", \"tooltip\":\"${model}\n${thermo} Temperature: ${temp}°C\n${speedo} Utilization: ${utilization}%\n Clock Speed: ${frequency}\"}"
|
echo "{\"text\":\"${thermo} ${temp}°C\", \"tooltip\":\"${model}\n${thermo} Temperature: ${temp}°C\n${speedo} Utilization: ${utilisation}%\n Clock Speed: ${frequency}\"}"
|
||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@@ -2886,7 +2907,7 @@ echo "{\"text\": \"${icon} ${ssid}\", \"tooltip\": \"${tooltip}\"}"
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### 3.6 Ghostty
|
### 4.6. Ghostty Configuration
|
||||||
|
|
||||||
```ini frame="code" title="~/.config/ghostty/config"
|
```ini frame="code" title="~/.config/ghostty/config"
|
||||||
font-family="OpenDyslexicM Nerd Font"
|
font-family="OpenDyslexicM Nerd Font"
|
||||||
@@ -2922,7 +2943,7 @@ cursor-color = #ff3b6f
|
|||||||
cursor-text = #ffe6ee
|
cursor-text = #ffe6ee
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.7 Discord
|
### 4.7. Discord Configuration
|
||||||
|
|
||||||
```json frame="code" title="~/.config/discord/settings.json"
|
```json frame="code" title="~/.config/discord/settings.json"
|
||||||
{
|
{
|
||||||
@@ -2941,7 +2962,7 @@ cursor-text = #ffe6ee
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.8 Hyfetch
|
### 4.8. Hyfetch Configuration
|
||||||
|
|
||||||
There are two config files here.
|
There are two config files here.
|
||||||
|
|
||||||
@@ -3093,7 +3114,7 @@ background_color=
|
|||||||
stdout="off"
|
stdout="off"
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.9 Wofi
|
### 4.9. Wofi Configuration
|
||||||
|
|
||||||
```css frame="code" title="~/.config/wofi/style.css"
|
```css frame="code" title="~/.config/wofi/style.css"
|
||||||
#window {
|
#window {
|
||||||
@@ -3146,7 +3167,7 @@ stdout="off"
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.10 Dunst
|
### 4.10. Dunst Configuration
|
||||||
|
|
||||||
`dunst` manages Naomi's system notifications, and (like many other aspects of her environment) has been highly customised.
|
`dunst` manages Naomi's system notifications, and (like many other aspects of her environment) has been highly customised.
|
||||||
|
|
||||||
@@ -3177,15 +3198,15 @@ stdout="off"
|
|||||||
frame_color="#ffefef"
|
frame_color="#ffefef"
|
||||||
```
|
```
|
||||||
|
|
||||||
## 4. Code Editors
|
## 5. CODE EDITORS
|
||||||
|
|
||||||
These are the code editors Naomi uses.
|
These are the code editors Naomi uses.
|
||||||
|
|
||||||
### 4.1. Emacs
|
### 5.1. Emacs Configuration
|
||||||
|
|
||||||
Naomi uses `emacs` for her main editor.
|
Naomi uses `emacs` for her main editor.
|
||||||
|
|
||||||
#### 4.1.1. Config
|
#### 5.1.1. Emacs Configuration File
|
||||||
|
|
||||||
```lisp frame="code" title="~/.emacs"
|
```lisp frame="code" title="~/.emacs"
|
||||||
(setq inhibit-startup-message t ; Don't show the splash screen
|
(setq inhibit-startup-message t ; Don't show the splash screen
|
||||||
@@ -3243,7 +3264,7 @@ Naomi uses `emacs` for her main editor.
|
|||||||
(set-face-background 'line-number-current-line nil)
|
(set-face-background 'line-number-current-line nil)
|
||||||
(set-face-foreground 'line-number-current-line "yellow")
|
(set-face-foreground 'line-number-current-line "yellow")
|
||||||
|
|
||||||
;; Optional: Customize line number format
|
;; Optional: Customise line number format
|
||||||
(setq display-line-numbers-width 4) ; Reserve space for line numbers
|
(setq display-line-numbers-width 4) ; Reserve space for line numbers
|
||||||
(setq display-line-numbers-widen t) ; Expand line number space as needed
|
(setq display-line-numbers-widen t) ; Expand line number space as needed
|
||||||
|
|
||||||
@@ -3394,3 +3415,46 @@ Naomi uses `emacs` for her main editor.
|
|||||||
;; If there is more than one, they won't work right.
|
;; If there is more than one, they won't work right.
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Development Environment Disclaimer
|
||||||
|
|
||||||
|
This Documentation is provided for informational purposes only. Our organisation:
|
||||||
|
|
||||||
|
- Does not require contributors to replicate this exact development environment
|
||||||
|
- Does not guarantee that replicating these configurations will result in identical development experiences
|
||||||
|
- Does not provide technical support for setting up or maintaining these configurations
|
||||||
|
- Reserves the right to modify or update this Documentation at any time without prior notice
|
||||||
|
|
||||||
|
### 6.3. Technical Accuracy Disclaimer
|
||||||
|
|
||||||
|
While we strive to maintain accurate and current information in this Documentation, technical specifications, software versions, and configuration details change frequently. Contributors are responsible for:
|
||||||
|
|
||||||
|
- Verifying current software versions and compatibility
|
||||||
|
- Adapting configurations to their specific system requirements
|
||||||
|
- Ensuring their development environment meets project requirements
|
||||||
|
- Consulting project-specific documentation for additional requirements
|
||||||
|
|
||||||
|
### 6.4. Third-Party Tools and Services
|
||||||
|
|
||||||
|
This Documentation references various third-party tools, services, and software packages. Our organisation:
|
||||||
|
|
||||||
|
- Does not endorse or guarantee the functionality, security, or availability of third-party tools
|
||||||
|
- Is not responsible for issues arising from the use of third-party tools or services
|
||||||
|
- Does not provide support for third-party tools beyond what is necessary for project functionality
|
||||||
|
- Recommends that contributors review third-party licenses, terms of service, and privacy policies
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Development Environment Documentation provides comprehensive information about the primary development environment used within our organisation. While contributors are not required to replicate this exact environment, this information serves as a valuable reference for understanding our development context, tooling preferences, and configuration standards.
|
||||||
|
|
||||||
|
All contributors are encouraged to use development environments that meet project requirements and align with their personal preferences and constraints. Questions about development environment setup or compatibility should be directed to project maintainers through appropriate communication channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about development environment requirements or to suggest improvements, please contact project maintainers through the designated channels outlined in our Contributor Covenant.*
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ Requires access to production infrastructure for proper testing and implementati
|
|||||||
|
|
||||||
Staff members working on these issues must adhere to all relevant confidentiality agreements, data protection policies, and internal security protocols.
|
Staff members working on these issues must adhere to all relevant confidentiality agreements, data protection policies, and internal security protocols.
|
||||||
|
|
||||||
### 1.4 Disclaimer
|
### 1.4. Disclaimer
|
||||||
|
|
||||||
Labels are assigned based on the project maintainers' best judgement but may not guarantee the exact level of difficulty or access requirements for every contributor. Contributors should use their discretion and communicate with project maintainers if they have any doubts about their ability to address an issue or comply with any associated legal requirements.
|
Labels are assigned based on the project maintainers' best judgement but may not guarantee the exact level of difficulty or access requirements for every contributor. Contributors should use their discretion and communicate with project maintainers if they have any doubts about their ability to address an issue or comply with any associated legal requirements.
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ Typically does not require code changes. Proficiency in technical writing is a m
|
|||||||
|
|
||||||
Contributors must ensure the accuracy of the information provided in documentation updates. Documentation changes should adhere to any applicable style guides and licensing terms.
|
Contributors must ensure the accuracy of the information provided in documentation updates. Documentation changes should adhere to any applicable style guides and licensing terms.
|
||||||
|
|
||||||
### 2.5 Disclaimer
|
### 2.5. Disclaimer
|
||||||
|
|
||||||
Aspect labels are assigned based on the primary focus of the issue but may not encompass all potential areas of impact. Contributors are encouraged to consider potential cross-aspect effects of their work and discuss these with project maintainers when in doubt. The project maintainers reserve the right to reassign aspect labels or request additional changes if the submitted work does not align with the intended scope of the issue.
|
Aspect labels are assigned based on the primary focus of the issue but may not encompass all potential areas of impact. Contributors are encouraged to consider potential cross-aspect effects of their work and discuss these with project maintainers when in doubt. The project maintainers reserve the right to reassign aspect labels or request additional changes if the submitted work does not align with the intended scope of the issue.
|
||||||
|
|
||||||
@@ -212,7 +212,7 @@ Important for project improvement but not critical for current functionality. Sh
|
|||||||
|
|
||||||
#### 4.3.3. Expectations
|
#### 4.3.3. Expectations
|
||||||
|
|
||||||
May involve improvements to user experience or accessibility, which could have legal implications if neglected long-term. Could relate to optimizations that affect performance guarantees or service level agreements.
|
May involve improvements to user experience or accessibility, which could have legal implications if neglected long-term. Could relate to optimisations that affect performance guarantees or service level agreements.
|
||||||
|
|
||||||
### 4.4. `priority: low`
|
### 4.4. `priority: low`
|
||||||
|
|
||||||
@@ -240,9 +240,9 @@ Not critical enough to dedicate maintainer time for resolution. Often left for c
|
|||||||
|
|
||||||
#### 4.5.3. Expectations
|
#### 4.5.3. Expectations
|
||||||
|
|
||||||
While not prioritized, maintainers should periodically review these issues to ensure they haven't become more significant over time, potentially accruing legal or compliance risks.
|
While not prioritised, maintainers should periodically review these issues to ensure they haven't become more significant over time, potentially accruing legal or compliance risks.
|
||||||
|
|
||||||
### 4.6 Disclaimer
|
### 4.6. Disclaimer
|
||||||
|
|
||||||
Priority labels reflect the project maintainers' current assessment and may be subject to change. The presence of a lower-priority label does not diminish the importance of the issue or the value of contributions addressing it. Contributors should communicate with maintainers if they believe an issue's priority should be reassessed due to new information or changing circumstances.
|
Priority labels reflect the project maintainers' current assessment and may be subject to change. The presence of a lower-priority label does not diminish the importance of the issue or the value of contributions addressing it. Contributors should communicate with maintainers if they believe an issue's priority should be reassessed due to new information or changing circumstances.
|
||||||
|
|
||||||
@@ -310,7 +310,7 @@ Clearly communicate the project's maintenance status to manage user expectations
|
|||||||
|
|
||||||
#### 5.5.1. Purpose
|
#### 5.5.1. Purpose
|
||||||
|
|
||||||
Indicates issues that need proper labeling and categorization.
|
Indicates issues that need proper labelling and categorisation.
|
||||||
|
|
||||||
#### 5.5.2. Characteristics
|
#### 5.5.2. Characteristics
|
||||||
|
|
||||||
@@ -318,7 +318,7 @@ May have ongoing discussions but lack appropriate classification.
|
|||||||
|
|
||||||
#### 5.5.3. Expectations
|
#### 5.5.3. Expectations
|
||||||
|
|
||||||
Proper labeling is crucial for efficient project management and may have implications for compliance tracking and reporting. Establish clear guidelines for labeling to ensure consistency and avoid potential misunderstandings.
|
Proper labelling is crucial for efficient project management and may have implications for compliance tracking and reporting. Establish clear guidelines for labelling to ensure consistency and avoid potential misunderstandings.
|
||||||
|
|
||||||
### 5.6. `status: ready for dev`
|
### 5.6. `status: ready for dev`
|
||||||
|
|
||||||
@@ -414,7 +414,7 @@ Signifies that the pull request is not in draft mode and is awaiting maintainer
|
|||||||
|
|
||||||
#### 7.2.2. Characteristics
|
#### 7.2.2. Characteristics
|
||||||
|
|
||||||
PR has been submitted as complete and ready for evaluation. Maintainers should prioritize reviewing these PRs.
|
PR has been submitted as complete and ready for evaluation. Maintainers should prioritise reviewing these PRs.
|
||||||
|
|
||||||
#### 7.2.3. Expectations
|
#### 7.2.3. Expectations
|
||||||
|
|
||||||
@@ -440,7 +440,7 @@ The presence of these labels does not guarantee that a pull request will be merg
|
|||||||
|
|
||||||
## 8. Continuous Improvement
|
## 8. Continuous Improvement
|
||||||
|
|
||||||
We encourage all project participants to provide feedback on our labeling system. If you have suggestions for improvements or notice any inconsistencies, please reach out to us in our [forums](https://forum.nhcarrigan.com).
|
We encourage all project participants to provide feedback on our labelling system. If you have suggestions for improvements or notice any inconsistencies, please reach out to us in our [Discord community](https://chat.nhcarrigan.com).
|
||||||
|
|
||||||
## 9. Legal Notice
|
## 9. Legal Notice
|
||||||
|
|
||||||
|
|||||||
@@ -2,17 +2,37 @@
|
|||||||
title: Server Setup
|
title: Server Setup
|
||||||
---
|
---
|
||||||
|
|
||||||
This document outlines how we set up our remote servers for running projects.
|
**ESTABLISHING SERVER CONFIGURATION STANDARDS AND SECURITY REQUIREMENTS**
|
||||||
|
|
||||||
## 1. Provision a Server
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Server Setup Documentation (hereinafter referred to as "the Documentation") establishes mandatory standards, procedures, and security requirements for configuring remote servers used to host projects maintained by our organisation. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Security Policy, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all remote servers used to host projects, services, or infrastructure maintained by our organisation. All personnel responsible for server configuration, deployment, or maintenance must comply with the standards set forth in this Documentation.
|
||||||
|
|
||||||
|
**IMPORTANT: Non-compliance with server security and configuration standards set forth in this Documentation may result in security vulnerabilities, service disruptions, or other serious consequences. All server administrators must strictly adhere to these requirements.**
|
||||||
|
|
||||||
|
### 1.3. Security and Compliance Requirements
|
||||||
|
|
||||||
|
Server configuration must comply with:
|
||||||
|
- Our Security Policy and security standards
|
||||||
|
- Applicable data protection and privacy regulations
|
||||||
|
- Industry best practices for server security
|
||||||
|
- All relevant legal and regulatory requirements
|
||||||
|
|
||||||
|
## 2. PROVISIONING A SERVER
|
||||||
|
|
||||||
We use DigitalOcean as our provider. Regardless of your choice, provision a new VPS using the **latest Ubuntu LTS version**. Add your `ssh` key AND Naomi's `ssh` key in the setup process.
|
We use DigitalOcean as our provider. Regardless of your choice, provision a new VPS using the **latest Ubuntu LTS version**. Add your `ssh` key AND Naomi's `ssh` key in the setup process.
|
||||||
|
|
||||||
## 2. Set Up User
|
## 3. SETTING UP USER ACCOUNTS
|
||||||
|
|
||||||
You should never run applications on root. SSH into the new VPS to prepare your user.
|
You should never run applications on root. SSH into the new VPS to prepare your user.
|
||||||
|
|
||||||
### 2.1. Creating the User
|
### 3.1. Creating the User Account
|
||||||
|
|
||||||
You'll need to set a password for the `root` account first.
|
You'll need to set a password for the `root` account first.
|
||||||
|
|
||||||
@@ -22,10 +42,10 @@ passwd
|
|||||||
|
|
||||||
Once you have set a password, ensure that you have provided it to Naomi to store in the vault.
|
Once you have set a password, ensure that you have provided it to Naomi to store in the vault.
|
||||||
|
|
||||||
Create an `nhcarrigan` user for our organisation.
|
Create an `NHCarrigan` user for our organisation.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
adduser nhcarrigan
|
adduser NHCarrigan
|
||||||
```
|
```
|
||||||
|
|
||||||
Set a **different** password, and provide that to Naomi as well. For all of the user information, use the default blank values.
|
Set a **different** password, and provide that to Naomi as well. For all of the user information, use the default blank values.
|
||||||
@@ -33,13 +53,13 @@ Set a **different** password, and provide that to Naomi as well. For all of the
|
|||||||
Add the new user to the sudoers file.
|
Add the new user to the sudoers file.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
usermod -aG sudo nhcarrigan
|
usermod -aG sudo NHCarrigan
|
||||||
```
|
```
|
||||||
|
|
||||||
Then sync the SSH keys so we can authenticate as that user.
|
Then sync the SSH keys so we can authenticate as that user.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
rsync --archive --chown=nhcarrigan:nhcarrigan ~/.ssh /home/nhcarrigan
|
rsync --archive --chown=NHCarrigan:NHCarrigan ~/.ssh /home/NHCarrigan
|
||||||
```
|
```
|
||||||
|
|
||||||
While you are there, set the timezone for the server to our business' local timezone.
|
While you are there, set the timezone for the server to our business' local timezone.
|
||||||
@@ -48,11 +68,11 @@ While you are there, set the timezone for the server to our business' local time
|
|||||||
sudo timedatectl set-timezone America/Los_Angeles
|
sudo timedatectl set-timezone America/Los_Angeles
|
||||||
```
|
```
|
||||||
|
|
||||||
## 3. Preparing For Web Requests
|
## 4. PREPARING FOR WEB REQUESTS
|
||||||
|
|
||||||
To prepare the server to receive web requests, you'll need to follow a few steps.
|
To prepare the server to receive web requests, you'll need to follow a few steps.
|
||||||
|
|
||||||
### 3.1. SSL Certificate
|
### 4.1. SSL Certificate Configuration
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
If the Firewall has been set up, you'll need to temporarily allow port 80 for the certificate to generate.
|
If the Firewall has been set up, you'll need to temporarily allow port 80 for the certificate to generate.
|
||||||
@@ -88,7 +108,7 @@ When you need to renew the certificate:
|
|||||||
sudo certbot renew
|
sudo certbot renew
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3.2. NGINX
|
### 4.2. NGINX Configuration
|
||||||
|
|
||||||
All requests should be routed through NGINX. At no point should an application run directly on ports 80 or 443.
|
All requests should be routed through NGINX. At no point should an application run directly on ports 80 or 443.
|
||||||
|
|
||||||
@@ -133,11 +153,11 @@ If so, restart NGINX to apply the changes:
|
|||||||
sudo systemctl restart nginx
|
sudo systemctl restart nginx
|
||||||
```
|
```
|
||||||
|
|
||||||
## 4. Securing the Server
|
## 5. SECURING THE SERVER
|
||||||
|
|
||||||
We have a minimum level of security that is required on ALL of our servers. This section should not be treated as the best effort, but as the minimal requirements to comply with our policies.
|
We have a minimum level of security that is required on ALL of our servers. This section should not be treated as the best effort, but as the minimal requirements to comply with our policies.
|
||||||
|
|
||||||
### 4.1. Firewall
|
### 5.1. Firewall Configuration
|
||||||
|
|
||||||
We use `ufw` as our firewall. First, enable the SSH port.
|
We use `ufw` as our firewall. First, enable the SSH port.
|
||||||
|
|
||||||
@@ -158,7 +178,7 @@ Enable the firewall. You may get dropped from the SSH connection.
|
|||||||
sudo ufw enable
|
sudo ufw enable
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.2. Fail2Ban
|
### 5.2. Fail2Ban Configuration
|
||||||
|
|
||||||
We also use Fail2Ban to block IP addresses which fail to make requests too often.
|
We also use Fail2Ban to block IP addresses which fail to make requests too often.
|
||||||
|
|
||||||
@@ -289,7 +309,7 @@ And to unban them:
|
|||||||
sudo fail2ban-client set nginx-auth unbanip <ip>
|
sudo fail2ban-client set nginx-auth unbanip <ip>
|
||||||
```
|
```
|
||||||
|
|
||||||
## 5. Uploading a Project
|
## 6. UPLOADING PROJECTS
|
||||||
|
|
||||||
To upload a project, you should **not** use `git` to clone the project to the machine. Instead, start by cloning the project to your local environment and navigating to the directory:
|
To upload a project, you should **not** use `git` to clone the project to the machine. Instead, start by cloning the project to your local environment and navigating to the directory:
|
||||||
|
|
||||||
@@ -301,14 +321,14 @@ cd /path/to/project
|
|||||||
Then sync the project up to the machine, ignoring any installed packages.
|
Then sync the project up to the machine, ignoring any installed packages.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
rsync -av --exclude='node_modules' ./ <server name>:/home/nhcarrigan/<project directory>
|
rsync -av --exclude='node_modules' ./ <server name>:/home/NHCarrigan/<project directory>
|
||||||
```
|
```
|
||||||
|
|
||||||
## 6. Running a Project
|
## 7. RUNNING PROJECTS
|
||||||
|
|
||||||
Now you are ready to start running the project.
|
Now you are ready to start running the project.
|
||||||
|
|
||||||
### 6.1. Node.js
|
### 7.1. Node.js Setup
|
||||||
|
|
||||||
Most of our projects will run on Node. For a new machine, you'll need to set that up.
|
Most of our projects will run on Node. For a new machine, you'll need to set that up.
|
||||||
|
|
||||||
@@ -338,7 +358,7 @@ Finally, install `pnpm` as the package manager.
|
|||||||
npm i -g pnpm
|
npm i -g pnpm
|
||||||
```
|
```
|
||||||
|
|
||||||
### 6.2. PM2
|
### 7.2. PM2 Process Management
|
||||||
|
|
||||||
All of our processes run with PM2 to allow for monitoring and auto-restarts. You'll need to install it.
|
All of our processes run with PM2 to allow for monitoring and auto-restarts. You'll need to install it.
|
||||||
|
|
||||||
@@ -353,3 +373,56 @@ pm2 start '<script>' --name '<name>'
|
|||||||
```
|
```
|
||||||
|
|
||||||
Then run `pm2 save` to save the application list.
|
Then run `pm2 save` to save the application list.
|
||||||
|
|
||||||
|
## 8. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 8.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 8.2. Server Configuration Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes mandatory security and configuration standards. However, compliance with these standards does not guarantee:
|
||||||
|
|
||||||
|
- Complete protection against all security threats or vulnerabilities
|
||||||
|
- Uninterrupted service availability or performance
|
||||||
|
- Compatibility with all applications or use cases
|
||||||
|
- Protection against all forms of attack or compromise
|
||||||
|
|
||||||
|
### 8.3. Security Disclaimer
|
||||||
|
|
||||||
|
While this Documentation establishes security requirements, server administrators are responsible for:
|
||||||
|
|
||||||
|
- Implementing additional security measures appropriate to their specific threat environment
|
||||||
|
- Regularly updating and patching all software and dependencies
|
||||||
|
- Monitoring server logs and security alerts
|
||||||
|
- Responding promptly to security incidents
|
||||||
|
- Maintaining compliance with all applicable security regulations and standards
|
||||||
|
|
||||||
|
### 8.4. Third-Party Services and Tools
|
||||||
|
|
||||||
|
This Documentation references various third-party services, tools, and software packages. Our organisation:
|
||||||
|
|
||||||
|
- Does not guarantee the security, availability, or functionality of third-party services
|
||||||
|
- Is not responsible for issues arising from the use of third-party tools or services
|
||||||
|
- Recommends that administrators review third-party licenses, terms of service, and security practices
|
||||||
|
- Does not provide support for third-party tools beyond what is necessary for project functionality
|
||||||
|
|
||||||
|
### 8.5. Technical Accuracy Disclaimer
|
||||||
|
|
||||||
|
While we strive to maintain accurate and current information in this Documentation, technical standards, software versions, and security best practices evolve continuously. Server administrators are responsible for:
|
||||||
|
|
||||||
|
- Verifying current software versions and compatibility
|
||||||
|
- Adapting configurations to their specific system requirements
|
||||||
|
- Ensuring compliance with current security standards and regulations
|
||||||
|
- Consulting additional resources for the most current security recommendations
|
||||||
|
|
||||||
|
## 9. CONCLUSION
|
||||||
|
|
||||||
|
This Server Setup Documentation establishes mandatory standards and procedures for configuring remote servers used to host projects maintained by our organisation. Strict adherence to these requirements is essential for maintaining security, reliability, and compliance with our organisational policies and legal obligations.
|
||||||
|
|
||||||
|
All personnel responsible for server configuration, deployment, or maintenance must familiarise themselves with and comply with the requirements set forth in this Documentation. Questions about server configuration requirements or security standards should be directed to appropriate technical leadership through designated communication channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about server configuration requirements or to suggest improvements, please contact technical leadership through the designated channels outlined in our Security Policy.*
|
||||||
|
|||||||
@@ -2,27 +2,47 @@
|
|||||||
title: Style Guide
|
title: Style Guide
|
||||||
---
|
---
|
||||||
|
|
||||||
This document outlines the style guide that applies to all of our projects.
|
**ESTABLISHING CODE STYLE STANDARDS AND CONVENTIONS FOR ALL PROJECTS**
|
||||||
|
|
||||||
## 1. Global Conventions
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Style Guide (hereinafter referred to as "the Guide") establishes mandatory code style standards, conventions, and formatting requirements applicable to all projects maintained by our organisation. This Guide operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Contributor Covenant, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Guide applies to all code contributions, regardless of contributor status, project type, or development context. All contributors are required to comply with the standards set forth in this Guide.
|
||||||
|
|
||||||
|
**IMPORTANT: Non-compliance with this Guide may result in rejection of contributions, requests for modification, or other appropriate actions as determined by project maintainers.**
|
||||||
|
|
||||||
|
### 1.3. Legal Compliance and Intellectual Property
|
||||||
|
|
||||||
|
All code contributions must comply with:
|
||||||
|
- Our global software licence: Naomi's Public Licence
|
||||||
|
- Contributor Covenant requirements
|
||||||
|
- Applicable intellectual property laws and regulations
|
||||||
|
- Export control and data protection requirements
|
||||||
|
|
||||||
|
## 2. GLOBAL CONVENTIONS
|
||||||
|
|
||||||
These sections apply to all code in any of our projects.
|
These sections apply to all code in any of our projects.
|
||||||
|
|
||||||
### 1.1. Copyright Notice
|
### 2.1. Copyright Notice
|
||||||
|
|
||||||
All code files should begin with a comment section containing the copyright information:
|
All code files should begin with a comment section containing the copyright information:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
/**
|
/**
|
||||||
* @copyright nhcarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that `copyright` _must_ be assigned to `nhcarrigan`, and our `license` must be applied, but when checking in new code you may attribute yourself as the author, or add yourself to the list for existing code.
|
Note that `copyright` _must_ be assigned to `NHCarrigan`, and our `license` must be applied, but when checking in new code you may attribute yourself as the author, or add yourself to the list for existing code.
|
||||||
|
|
||||||
## 2. JavaScript Projects
|
## 3. JAVASCRIPT AND TYPESCRIPT PROJECTS
|
||||||
|
|
||||||
The following sections apply to our JavaScript/TypeScript projects. Style conventions are enforced through our [custom ESLint package](/projects/eslint).
|
The following sections apply to our JavaScript/TypeScript projects. Style conventions are enforced through our [custom ESLint package](/projects/eslint).
|
||||||
|
|
||||||
@@ -43,11 +63,11 @@ If you are using VSCode, you can add this to your `.vscode/settings.json` file i
|
|||||||
Because of this, our style guide will not cover the formatting section of our linter package.
|
Because of this, our style guide will not cover the formatting section of our linter package.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## 2.1. Main Rules
|
### 3.1. Main Rules
|
||||||
|
|
||||||
These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`.
|
These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`.
|
||||||
|
|
||||||
### 2.1.1. `eslint` Enforced Rules
|
#### 3.1.1. ESLint Enforced Rules
|
||||||
|
|
||||||
- Setters must have a corresponding getter.
|
- Setters must have a corresponding getter.
|
||||||
- Array methods which return a value must return a value in the callback.
|
- Array methods which return a value must return a value in the callback.
|
||||||
@@ -193,7 +213,7 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- `typeof` comparators must be a valid return type of `typeof`.
|
- `typeof` comparators must be a valid return type of `typeof`.
|
||||||
- Conditions should always start with the variable, not the constant.
|
- Conditions should always start with the variable, not the constant.
|
||||||
|
|
||||||
### 2.1.2. `typescript-eslint` Enforced Rules
|
#### 3.1.2. TypeScript-ESLint Enforced Rules
|
||||||
|
|
||||||
- Do not use `await` on functions that do not return a Promise.
|
- Do not use `await` on functions that do not return a Promise.
|
||||||
- Exported type definitions should use the `export type` keyword.
|
- Exported type definitions should use the `export type` keyword.
|
||||||
@@ -297,16 +317,16 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- Do not use TypeScript's `///` reference.
|
- Do not use TypeScript's `///` reference.
|
||||||
- Do not use overloads when the same result can be achieved via union types or optional parameters.
|
- Do not use overloads when the same result can be achieved via union types or optional parameters.
|
||||||
|
|
||||||
### 2.1.3. `eslint-comments` Enforced Rules
|
#### 3.1.3. ESLint-Comments Enforced Rules
|
||||||
|
|
||||||
- Do not use blanket `eslint-disable` directives. All `disable` directives must target specific rules.
|
- Do not use blanket `eslint-disable` directives. All `disable` directives must target specific rules.
|
||||||
- All `disable` directives must include a comment explaining why the linter is being bypassed.
|
- All `disable` directives must include a comment explaining why the linter is being bypassed.
|
||||||
|
|
||||||
### 2.1.4. `deprecation` Enforced Rules
|
#### 3.1.4. Deprecation Enforced Rules
|
||||||
|
|
||||||
- Do not use deprecated methods/features, even if the package still supports them.
|
- Do not use deprecated methods/features, even if the package still supports them.
|
||||||
|
|
||||||
### 2.1.5. `import` Enforced Rules
|
#### 3.1.5. Import Enforced Rules
|
||||||
|
|
||||||
- Do not use default imports if the module does not have a default export.
|
- Do not use default imports if the module does not have a default export.
|
||||||
- Do not import modules simply to re-export them.
|
- Do not import modules simply to re-export them.
|
||||||
@@ -333,7 +353,7 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- Imports must be sorted alphabetically, first grouped by: builtin node modules, external packages, internal packages, modules in parent directory, modules in current directory, type-only imports.
|
- Imports must be sorted alphabetically, first grouped by: builtin node modules, external packages, internal packages, modules in parent directory, modules in current directory, type-only imports.
|
||||||
- There should be no new lines between these groups.
|
- There should be no new lines between these groups.
|
||||||
|
|
||||||
### 2.1.6. `jsdoc` Enforced Rules
|
#### 3.1.6. JSDoc Enforced Rules
|
||||||
|
|
||||||
- `@access` tags should be one of `package`, `private`, `protected`, or `public`.
|
- `@access` tags should be one of `package`, `private`, `protected`, or `public`.
|
||||||
- Asterisks should be aligned.
|
- Asterisks should be aligned.
|
||||||
@@ -343,7 +363,7 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- Should not use `=` (GCC syntax).
|
- Should not use `=` (GCC syntax).
|
||||||
- All tags must be valid JSDoc tags.
|
- All tags must be valid JSDoc tags.
|
||||||
- `@template` names should be used in the `@typedef`.
|
- `@template` names should be used in the `@typedef`.
|
||||||
- `@license` tag MUST be set to `Naomi's Public License`.
|
- `@license` tag MUST be set to `Naomi's Public Licence`.
|
||||||
- Tags that do not expect content should not have content.
|
- Tags that do not expect content should not have content.
|
||||||
- `@implements` should only be used on constructors or classes.
|
- `@implements` should only be used on constructors or classes.
|
||||||
- Tag descriptions should not be just a reflection of the name.
|
- Tag descriptions should not be just a reflection of the name.
|
||||||
@@ -363,7 +383,7 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- There should be no blank lines between tags.
|
- There should be no blank lines between tags.
|
||||||
- Any types referenced must be valid types.
|
- Any types referenced must be valid types.
|
||||||
|
|
||||||
### 2.1.7. `unicorn` Enforced Rules
|
#### 3.1.7. Unicorn Enforced Rules
|
||||||
|
|
||||||
- Regular expressions should use special shorthand where possible.
|
- Regular expressions should use special shorthand where possible.
|
||||||
- `catch` blocks should always have `error` as the parameter.
|
- `catch` blocks should always have `error` as the parameter.
|
||||||
@@ -433,7 +453,7 @@ These rules apply to all TypeScript code, and will run on files in `src/**/*.ts`
|
|||||||
- `Array.join()` must always be given a separator.
|
- `Array.join()` must always be given a separator.
|
||||||
- `Number.toFixed()` must always be given a digits argument.
|
- `Number.toFixed()` must always be given a digits argument.
|
||||||
|
|
||||||
## 2.2. React Rules
|
### 3.2. React Rules
|
||||||
|
|
||||||
These rules apply to TSX, and will run on files in `src/**/*.tsx`.
|
These rules apply to TSX, and will run on files in `src/**/*.tsx`.
|
||||||
|
|
||||||
@@ -499,7 +519,7 @@ These rules apply to TSX, and will run on files in `src/**/*.tsx`.
|
|||||||
- The `style` property must always be an object.
|
- The `style` property must always be an object.
|
||||||
- Void elements `img`, `br` etc. must never have children.
|
- Void elements `img`, `br` etc. must never have children.
|
||||||
|
|
||||||
## 2.3. Playwright Rules
|
### 3.3. Playwright Rules
|
||||||
|
|
||||||
These files apply to Playwright End-to-end tests, and will run on `e2e/**/*.spec.ts`.
|
These files apply to Playwright End-to-end tests, and will run on `e2e/**/*.spec.ts`.
|
||||||
|
|
||||||
@@ -542,7 +562,7 @@ These files apply to Playwright End-to-end tests, and will run on `e2e/**/*.spec
|
|||||||
- Promises that contain an `expect` must be awaited.
|
- Promises that contain an `expect` must be awaited.
|
||||||
- Tests must have a title that is not empty.
|
- Tests must have a title that is not empty.
|
||||||
|
|
||||||
## 2.4. Vitest Rules
|
### 3.4. Vitest Rules
|
||||||
|
|
||||||
These files apply to Vitest unit tests, and will run on `test/**/*.spec.ts`.
|
These files apply to Vitest unit tests, and will run on `test/**/*.spec.ts`.
|
||||||
|
|
||||||
@@ -593,3 +613,37 @@ We also mandate the use of `describe`, `it`, and `expect` over `suite`, `test`,
|
|||||||
- The `describe` callback should not have any parameters and cannot use `return`.
|
- The `describe` callback should not have any parameters and cannot use `return`.
|
||||||
- All `expect()` calls must have a custom message.
|
- All `expect()` calls must have a custom message.
|
||||||
- Tests must have a title that is not empty.
|
- Tests must have a title that is not empty.
|
||||||
|
|
||||||
|
## 4. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 4.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 4.2. Style Guide Disclaimer
|
||||||
|
|
||||||
|
This Guide establishes mandatory standards for code contributions. However, compliance with this Guide does not guarantee acceptance of contributions. Project maintainers reserve the right to:
|
||||||
|
|
||||||
|
- Request modifications to code that complies with this Guide
|
||||||
|
- Reject contributions for reasons beyond style compliance
|
||||||
|
- Modify or update this Guide at any time without prior notice
|
||||||
|
- Interpret Guide requirements in specific contexts as necessary
|
||||||
|
|
||||||
|
### 4.3. Technical Accuracy Disclaimer
|
||||||
|
|
||||||
|
While we strive to maintain accurate and current information in this Guide, technical standards, tooling, and best practices evolve continuously. Contributors are responsible for:
|
||||||
|
|
||||||
|
- Verifying current tool versions and compatibility
|
||||||
|
- Ensuring their development environment matches project requirements
|
||||||
|
- Adapting to updates in this Guide as they are published
|
||||||
|
- Consulting project-specific documentation for additional requirements
|
||||||
|
|
||||||
|
## 5. CONCLUSION
|
||||||
|
|
||||||
|
This Style Guide represents our commitment to maintaining high-quality, consistent, and maintainable code across all projects. By adhering to these standards, contributors help ensure that our codebase remains accessible, professional, and aligned with industry best practices.
|
||||||
|
|
||||||
|
All contributors are expected to familiarise themselves with and comply with the requirements set forth in this Guide. Questions about specific requirements or requests for clarification should be directed to project maintainers through appropriate communication channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about style requirements or to suggest improvements, please contact project maintainers through the designated channels outlined in our Contributor Covenant.*
|
||||||
|
|||||||
@@ -6,15 +6,15 @@ title: Acceptable Use Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Purpose
|
### 1.1. Policy Purpose
|
||||||
|
|
||||||
This Acceptable Use Policy ("AUP") establishes comprehensive guidelines for the appropriate use of all services, applications, and platforms provided by nhcarrigan ("we," "us," "our," or "the Company"). This AUP supplements our Terms of Service and other applicable policies to provide detailed guidance on acceptable and prohibited usage patterns.
|
This Acceptable Use Policy ("AUP") establishes comprehensive guidelines for the appropriate use of all services, applications, and platforms provided by NHCarrigan ("we," "us," "our," or "the Company"). This AUP supplements our Terms of Service and other applicable policies to provide detailed guidance on acceptable and prohibited usage patterns.
|
||||||
|
|
||||||
### 1.2 Scope of Application
|
### 1.2. Scope of Application
|
||||||
|
|
||||||
This AUP applies to all users of our Services, including:
|
This AUP applies to all users of our Services, including:
|
||||||
|
|
||||||
**(a)** All websites, web applications, and online platforms operated by nhcarrigan;
|
**(a)** All websites, web applications, and online platforms operated by NHCarrigan;
|
||||||
|
|
||||||
**(b)** Application Programming Interfaces (APIs) and related development tools;
|
**(b)** Application Programming Interfaces (APIs) and related development tools;
|
||||||
|
|
||||||
@@ -24,9 +24,9 @@ This AUP applies to all users of our Services, including:
|
|||||||
|
|
||||||
**(e)** Support services, documentation, and auxiliary platforms;
|
**(e)** Support services, documentation, and auxiliary platforms;
|
||||||
|
|
||||||
**(f)** Any other services, platforms, or tools provided by nhcarrigan.
|
**(f)** Any other services, platforms, or tools provided by NHCarrigan.
|
||||||
|
|
||||||
### 1.3 Integration with Other Policies
|
### 1.3. Integration with Other Policies
|
||||||
|
|
||||||
This AUP operates in conjunction with our comprehensive policy framework:
|
This AUP operates in conjunction with our comprehensive policy framework:
|
||||||
|
|
||||||
@@ -50,13 +50,13 @@ This AUP operates in conjunction with our comprehensive policy framework:
|
|||||||
|
|
||||||
Where conflicts arise between policies, the most restrictive terms shall apply to ensure maximum protection for all users and our organisation.
|
Where conflicts arise between policies, the most restrictive terms shall apply to ensure maximum protection for all users and our organisation.
|
||||||
|
|
||||||
### 1.4 Acceptance and Compliance
|
### 1.4. Acceptance and Compliance
|
||||||
|
|
||||||
By accessing or using any of our Services, you acknowledge that you have read, understood, and agree to comply with this AUP. Continued use of the Services constitutes ongoing acceptance of these terms and any modifications we may make.
|
By accessing or using any of our Services, you acknowledge that you have read, understood, and agree to comply with this AUP. Continued use of the Services constitutes ongoing acceptance of these terms and any modifications we may make.
|
||||||
|
|
||||||
## 2. GENERAL ACCEPTABLE USE PRINCIPLES
|
## 2. GENERAL ACCEPTABLE USE PRINCIPLES
|
||||||
|
|
||||||
### 2.1 Fundamental Usage Principles
|
### 2.1. Fundamental Usage Principles
|
||||||
|
|
||||||
All use of our Services must be consistent with the following principles:
|
All use of our Services must be consistent with the following principles:
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ All use of our Services must be consistent with the following principles:
|
|||||||
|
|
||||||
**(e)** **Security Awareness**: Users must take reasonable precautions to maintain security and report potential security issues.
|
**(e)** **Security Awareness**: Users must take reasonable precautions to maintain security and report potential security issues.
|
||||||
|
|
||||||
### 2.2 Community Standards
|
### 2.2. Community Standards
|
||||||
|
|
||||||
Our Services are designed to foster positive, inclusive communities. All usage must:
|
Our Services are designed to foster positive, inclusive communities. All usage must:
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ Our Services are designed to foster positive, inclusive communities. All usage m
|
|||||||
|
|
||||||
**(e)** **Respect Boundaries**: Acknowledge and respect other users' boundaries and preferences.
|
**(e)** **Respect Boundaries**: Acknowledge and respect other users' boundaries and preferences.
|
||||||
|
|
||||||
### 2.3 Ethical Usage Requirements
|
### 2.3. Ethical Usage Requirements
|
||||||
|
|
||||||
Users are expected to:
|
Users are expected to:
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ Users are expected to:
|
|||||||
|
|
||||||
## 3. PROHIBITED ACTIVITIES AND CONTENT
|
## 3. PROHIBITED ACTIVITIES AND CONTENT
|
||||||
|
|
||||||
### 3.1 Illegal Activities
|
### 3.1. Illegal Activities
|
||||||
|
|
||||||
Users are strictly prohibited from using our Services for:
|
Users are strictly prohibited from using our Services for:
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ Users are strictly prohibited from using our Services for:
|
|||||||
|
|
||||||
**(h)** **Human Trafficking**: Any form of human trafficking or exploitation.
|
**(h)** **Human Trafficking**: Any form of human trafficking or exploitation.
|
||||||
|
|
||||||
### 3.2 Abuse and Harassment
|
### 3.2. Abuse and Harassment
|
||||||
|
|
||||||
Our Services may not be used for:
|
Our Services may not be used for:
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ Our Services may not be used for:
|
|||||||
|
|
||||||
**(h)** **Discrimination**: Content or behaviour that discriminates against individuals or groups.
|
**(h)** **Discrimination**: Content or behaviour that discriminates against individuals or groups.
|
||||||
|
|
||||||
### 3.3 Spam and Unsolicited Communications
|
### 3.3. Spam and Unsolicited Communications
|
||||||
|
|
||||||
Prohibited spam and unsolicited communication activities include:
|
Prohibited spam and unsolicited communication activities include:
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ Prohibited spam and unsolicited communication activities include:
|
|||||||
|
|
||||||
**(h)** **Referral Abuse**: Manipulating referral or affiliate programmes through deceptive means.
|
**(h)** **Referral Abuse**: Manipulating referral or affiliate programmes through deceptive means.
|
||||||
|
|
||||||
### 3.4 Technical Abuse and Security Violations
|
### 3.4. Technical Abuse and Security Violations
|
||||||
|
|
||||||
Users may not engage in:
|
Users may not engage in:
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ Users may not engage in:
|
|||||||
|
|
||||||
**(h)** **Circumvention**: Bypassing security measures, access controls, or usage limitations.
|
**(h)** **Circumvention**: Bypassing security measures, access controls, or usage limitations.
|
||||||
|
|
||||||
### 3.5 Intellectual Property Violations
|
### 3.5. Intellectual Property Violations
|
||||||
|
|
||||||
Prohibited intellectual property violations include:
|
Prohibited intellectual property violations include:
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ Prohibited intellectual property violations include:
|
|||||||
|
|
||||||
**(h)** **False Attribution**: Misrepresenting the source or ownership of intellectual property.
|
**(h)** **False Attribution**: Misrepresenting the source or ownership of intellectual property.
|
||||||
|
|
||||||
### 3.6 Harmful Content
|
### 3.6. Harmful Content
|
||||||
|
|
||||||
**Reference to Content and Moderation Policy**: Detailed standards for prohibited content, including violent, adult, exploitative, and harmful content, are comprehensively covered in our Content and Moderation Policy, which is incorporated herein by reference.
|
**Reference to Content and Moderation Policy**: Detailed standards for prohibited content, including violent, adult, exploitative, and harmful content, are comprehensively covered in our Content and Moderation Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
@@ -208,7 +208,7 @@ Users may not upload, share, or distribute any content that violates the standar
|
|||||||
|
|
||||||
## 4. SPECIFIC PLATFORM USAGE GUIDELINES
|
## 4. SPECIFIC PLATFORM USAGE GUIDELINES
|
||||||
|
|
||||||
### 4.1 Community Platform Usage
|
### 4.1. Community Platform Usage
|
||||||
|
|
||||||
When using our community forums, chat services, and interactive platforms:
|
When using our community forums, chat services, and interactive platforms:
|
||||||
|
|
||||||
@@ -228,7 +228,7 @@ When using our community forums, chat services, and interactive platforms:
|
|||||||
|
|
||||||
**(h)** **Language Standards**: Use clear, respectful language appropriate for the community context.
|
**(h)** **Language Standards**: Use clear, respectful language appropriate for the community context.
|
||||||
|
|
||||||
### 4.2 API and Development Tool Usage
|
### 4.2. API and Development Tool Usage
|
||||||
|
|
||||||
When using our APIs and development tools:
|
When using our APIs and development tools:
|
||||||
|
|
||||||
@@ -248,7 +248,7 @@ When using our APIs and development tools:
|
|||||||
|
|
||||||
**(h)** **Updates**: Stay informed about API changes and update implementations accordingly.
|
**(h)** **Updates**: Stay informed about API changes and update implementations accordingly.
|
||||||
|
|
||||||
### 4.3 Content Submission and Sharing
|
### 4.3. Content Submission and Sharing
|
||||||
|
|
||||||
When submitting or sharing content through our Services:
|
When submitting or sharing content through our Services:
|
||||||
|
|
||||||
@@ -270,7 +270,7 @@ When submitting or sharing content through our Services:
|
|||||||
|
|
||||||
## 5. COMMERCIAL AND BUSINESS USE
|
## 5. COMMERCIAL AND BUSINESS USE
|
||||||
|
|
||||||
### 5.1 Permitted Commercial Activities
|
### 5.1. Permitted Commercial Activities
|
||||||
|
|
||||||
The following commercial activities are generally permitted when conducted in accordance with applicable terms:
|
The following commercial activities are generally permitted when conducted in accordance with applicable terms:
|
||||||
|
|
||||||
@@ -290,7 +290,7 @@ The following commercial activities are generally permitted when conducted in ac
|
|||||||
|
|
||||||
**(h)** **Research Activities**: Conducting legitimate research or academic studies.
|
**(h)** **Research Activities**: Conducting legitimate research or academic studies.
|
||||||
|
|
||||||
### 5.2 Prohibited Commercial Activities
|
### 5.2. Prohibited Commercial Activities
|
||||||
|
|
||||||
The following commercial activities are prohibited:
|
The following commercial activities are prohibited:
|
||||||
|
|
||||||
@@ -310,7 +310,7 @@ The following commercial activities are prohibited:
|
|||||||
|
|
||||||
**(h)** **Brand Confusion**: Using our brand or trademarks in ways that create confusion.
|
**(h)** **Brand Confusion**: Using our brand or trademarks in ways that create confusion.
|
||||||
|
|
||||||
### 5.3 Commercial Use Authorisation
|
### 5.3. Commercial Use Authorisation
|
||||||
|
|
||||||
For commercial activities that may require special authorisation:
|
For commercial activities that may require special authorisation:
|
||||||
|
|
||||||
@@ -332,7 +332,7 @@ For commercial activities that may require special authorisation:
|
|||||||
|
|
||||||
## 6. RESOURCE USAGE AND PERFORMANCE
|
## 6. RESOURCE USAGE AND PERFORMANCE
|
||||||
|
|
||||||
### 6.1 Fair Use of System Resources
|
### 6.1. Fair Use of System Resources
|
||||||
|
|
||||||
Users must:
|
Users must:
|
||||||
|
|
||||||
@@ -352,7 +352,7 @@ Users must:
|
|||||||
|
|
||||||
**(h)** **Graceful Degradation**: Implement graceful degradation when resources are limited.
|
**(h)** **Graceful Degradation**: Implement graceful degradation when resources are limited.
|
||||||
|
|
||||||
### 6.2 Prohibited Resource Usage
|
### 6.2. Prohibited Resource Usage
|
||||||
|
|
||||||
The following resource usage patterns are prohibited:
|
The following resource usage patterns are prohibited:
|
||||||
|
|
||||||
@@ -372,7 +372,7 @@ The following resource usage patterns are prohibited:
|
|||||||
|
|
||||||
**(h)** **Storage Abuse**: Using storage services for inappropriate content or excessive backup purposes.
|
**(h)** **Storage Abuse**: Using storage services for inappropriate content or excessive backup purposes.
|
||||||
|
|
||||||
### 6.3 Performance Impact Mitigation
|
### 6.3. Performance Impact Mitigation
|
||||||
|
|
||||||
To minimise performance impact on other users:
|
To minimise performance impact on other users:
|
||||||
|
|
||||||
@@ -394,7 +394,7 @@ To minimise performance impact on other users:
|
|||||||
|
|
||||||
## 7. DATA HANDLING AND PRIVACY
|
## 7. DATA HANDLING AND PRIVACY
|
||||||
|
|
||||||
### 7.1 Personal Data Protection
|
### 7.1. Personal Data Protection
|
||||||
|
|
||||||
Users must:
|
Users must:
|
||||||
|
|
||||||
@@ -414,7 +414,7 @@ Users must:
|
|||||||
|
|
||||||
**(h)** **Legal Compliance**: Comply with all applicable data protection laws and regulations.
|
**(h)** **Legal Compliance**: Comply with all applicable data protection laws and regulations.
|
||||||
|
|
||||||
### 7.2 Prohibited Data Practices
|
### 7.2. Prohibited Data Practices
|
||||||
|
|
||||||
Users may not:
|
Users may not:
|
||||||
|
|
||||||
@@ -434,7 +434,7 @@ Users may not:
|
|||||||
|
|
||||||
**(h)** **Retention Abuse**: Retain personal data longer than necessary or permitted.
|
**(h)** **Retention Abuse**: Retain personal data longer than necessary or permitted.
|
||||||
|
|
||||||
### 7.3 Data Security Requirements
|
### 7.3. Data Security Requirements
|
||||||
|
|
||||||
When handling data through our services:
|
When handling data through our services:
|
||||||
|
|
||||||
@@ -456,7 +456,7 @@ When handling data through our services:
|
|||||||
|
|
||||||
## 8. ENFORCEMENT AND COMPLIANCE
|
## 8. ENFORCEMENT AND COMPLIANCE
|
||||||
|
|
||||||
### 8.1 Monitoring and Detection
|
### 8.1. Monitoring and Detection
|
||||||
|
|
||||||
We employ various methods to monitor compliance with this AUP:
|
We employ various methods to monitor compliance with this AUP:
|
||||||
|
|
||||||
@@ -476,7 +476,7 @@ We employ various methods to monitor compliance with this AUP:
|
|||||||
|
|
||||||
**(h)** **Behavioural Analysis**: Monitoring for suspicious or harmful behavioural patterns.
|
**(h)** **Behavioural Analysis**: Monitoring for suspicious or harmful behavioural patterns.
|
||||||
|
|
||||||
### 8.2 Violation Response Procedures
|
### 8.2. Violation Response Procedures
|
||||||
|
|
||||||
When violations are identified, we may take the following actions:
|
When violations are identified, we may take the following actions:
|
||||||
|
|
||||||
@@ -496,7 +496,7 @@ When violations are identified, we may take the following actions:
|
|||||||
|
|
||||||
**(h)** **Law Enforcement**: Report criminal activities to appropriate law enforcement agencies.
|
**(h)** **Law Enforcement**: Report criminal activities to appropriate law enforcement agencies.
|
||||||
|
|
||||||
### 8.3 Progressive Enforcement
|
### 8.3. Progressive Enforcement
|
||||||
|
|
||||||
Our enforcement approach generally follows a progressive model:
|
Our enforcement approach generally follows a progressive model:
|
||||||
|
|
||||||
@@ -516,7 +516,7 @@ Our enforcement approach generally follows a progressive model:
|
|||||||
|
|
||||||
**(h)** **Repeated Offenders**: Enhanced penalties for users with previous violation history.
|
**(h)** **Repeated Offenders**: Enhanced penalties for users with previous violation history.
|
||||||
|
|
||||||
### 8.4 Appeals and Review
|
### 8.4. Appeals and Review
|
||||||
|
|
||||||
Users may appeal enforcement actions through:
|
Users may appeal enforcement actions through:
|
||||||
|
|
||||||
@@ -538,7 +538,7 @@ Users may appeal enforcement actions through:
|
|||||||
|
|
||||||
## 9. REPORTING VIOLATIONS
|
## 9. REPORTING VIOLATIONS
|
||||||
|
|
||||||
### 9.1 Community Reporting
|
### 9.1. Community Reporting
|
||||||
|
|
||||||
We encourage users to report policy violations through:
|
We encourage users to report policy violations through:
|
||||||
|
|
||||||
@@ -558,7 +558,7 @@ We encourage users to report policy violations through:
|
|||||||
|
|
||||||
**(h)** **Follow-up**: Follow-up communication about report status and outcomes.
|
**(h)** **Follow-up**: Follow-up communication about report status and outcomes.
|
||||||
|
|
||||||
### 9.2 What to Include in Reports
|
### 9.2. What to Include in Reports
|
||||||
|
|
||||||
Effective violation reports should include:
|
Effective violation reports should include:
|
||||||
|
|
||||||
@@ -578,7 +578,7 @@ Effective violation reports should include:
|
|||||||
|
|
||||||
**(h)** **Contact Information**: Your contact information for follow-up questions.
|
**(h)** **Contact Information**: Your contact information for follow-up questions.
|
||||||
|
|
||||||
### 9.3 Reporter Protection
|
### 9.3. Reporter Protection
|
||||||
|
|
||||||
We are committed to protecting users who report violations:
|
We are committed to protecting users who report violations:
|
||||||
|
|
||||||
@@ -600,7 +600,7 @@ We are committed to protecting users who report violations:
|
|||||||
|
|
||||||
## 10. POLICY UPDATES AND MODIFICATIONS
|
## 10. POLICY UPDATES AND MODIFICATIONS
|
||||||
|
|
||||||
### 10.1 Right to Modify
|
### 10.1. Right to Modify
|
||||||
|
|
||||||
We reserve the right to modify this AUP at any time to:
|
We reserve the right to modify this AUP at any time to:
|
||||||
|
|
||||||
@@ -620,7 +620,7 @@ We reserve the right to modify this AUP at any time to:
|
|||||||
|
|
||||||
**(h)** **Effectiveness**: Improve the effectiveness of policy enforcement.
|
**(h)** **Effectiveness**: Improve the effectiveness of policy enforcement.
|
||||||
|
|
||||||
### 10.2 Notification of Changes
|
### 10.2. Notification of Changes
|
||||||
|
|
||||||
Material changes to this AUP will be communicated through:
|
Material changes to this AUP will be communicated through:
|
||||||
|
|
||||||
@@ -636,11 +636,11 @@ Material changes to this AUP will be communicated through:
|
|||||||
|
|
||||||
**(f)** **Version History**: Maintained version history of policy changes;
|
**(f)** **Version History**: Maintained version history of policy changes;
|
||||||
|
|
||||||
**(g)** **Effective Date Notice**: Clear indication of when changes become effective;
|
**(g)** **Change Notice**: Clear indication of when changes become effective;
|
||||||
|
|
||||||
**(h)** **Transition Periods**: Reasonable transition periods for compliance with new requirements.
|
**(h)** **Transition Periods**: Reasonable transition periods for compliance with new requirements.
|
||||||
|
|
||||||
### 10.3 User Response to Changes
|
### 10.3. User Response to Changes
|
||||||
|
|
||||||
Following notification of policy changes:
|
Following notification of policy changes:
|
||||||
|
|
||||||
@@ -662,7 +662,7 @@ Following notification of policy changes:
|
|||||||
|
|
||||||
## 11. CONTACT INFORMATION AND SUPPORT
|
## 11. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 11.1 Policy Questions and Clarifications
|
### 11.1. Policy Questions and Clarifications
|
||||||
|
|
||||||
For questions about this AUP:
|
For questions about this AUP:
|
||||||
|
|
||||||
@@ -672,7 +672,7 @@ For questions about this AUP:
|
|||||||
|
|
||||||
**Response Time:** Within 3 business days for policy clarification requests
|
**Response Time:** Within 3 business days for policy clarification requests
|
||||||
|
|
||||||
### 11.2 Violation Reporting
|
### 11.2. Violation Reporting
|
||||||
|
|
||||||
To report policy violations:
|
To report policy violations:
|
||||||
|
|
||||||
@@ -682,7 +682,7 @@ To report policy violations:
|
|||||||
|
|
||||||
**Response Time:** Within 24 hours for urgent safety issues, 48 hours for standard reports
|
**Response Time:** Within 24 hours for urgent safety issues, 48 hours for standard reports
|
||||||
|
|
||||||
### 11.3 Appeals and Disputes
|
### 11.3. Appeals and Disputes
|
||||||
|
|
||||||
For appeals related to AUP enforcement:
|
For appeals related to AUP enforcement:
|
||||||
|
|
||||||
@@ -692,24 +692,16 @@ For appeals related to AUP enforcement:
|
|||||||
|
|
||||||
**Process:** Follow our Community Appeals Policy procedures
|
**Process:** Follow our Community Appeals Policy procedures
|
||||||
|
|
||||||
### 11.4 Technical Support
|
### 11.4. Technical Support
|
||||||
|
|
||||||
For technical issues related to policy compliance:
|
For technical issues related to policy compliance:
|
||||||
|
|
||||||
**Email:** support@nhcarrigan.com
|
**Email:** support@nhcarrigan.com
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Response Time:** Within 48 hours for technical support requests
|
**Response Time:** Within 48 hours for technical support requests
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 September 2026
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Acceptable Use Policy establishes comprehensive guidelines for appropriate use of our services. By using our Services, you agree to comply with these usage standards and acknowledge that violations may result in service restrictions or termination. For questions about acceptable use or to report violations, please contact us at aup@nhcarrigan.com.*
|
*This Acceptable Use Policy establishes comprehensive guidelines for appropriate use of our services. By using our Services, you agree to comply with these usage standards and acknowledge that violations may result in service restrictions or termination. For questions about acceptable use or to report violations, please contact us at aup@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,18 +6,18 @@ title: Community Growth Policy
|
|||||||
|
|
||||||
## 1. POLICY OVERVIEW AND COMMITMENT
|
## 1. POLICY OVERVIEW AND COMMITMENT
|
||||||
|
|
||||||
### 1.1 Growth Philosophy and Values
|
### 1.1. Growth Philosophy and Values
|
||||||
|
|
||||||
This Community Growth Policy establishes ethical guidelines for how community members can contribute to sustainable, values-aligned community growth. Our approach prioritizes quality relationships over quantity metrics, emphasizing authentic connection, mutual support, and alignment with our core values of social justice, inclusivity, and community empowerment.
|
This Community Growth Policy establishes ethical guidelines for how community members can contribute to sustainable, values-aligned community growth. Our approach prioritises quality relationships over quantity metrics, emphasising authentic connection, mutual support, and alignment with our core values of social justice, inclusivity, and community empowerment.
|
||||||
|
|
||||||
### 1.2 Core Growth Principles
|
### 1.2. Core Growth Principles
|
||||||
|
|
||||||
**Values-Driven Growth:**
|
**Values-Driven Growth:**
|
||||||
- **Quality Over Quantity**: Focus on meaningful connections rather than numerical growth
|
- **Quality Over Quantity**: Focus on meaningful connections rather than numerical growth
|
||||||
- **Authentic Engagement**: Genuine interest in community values and participation
|
- **Authentic Engagement**: Genuine interest in community values and participation
|
||||||
- **Mutual Benefit**: Growth that benefits both new and existing community members
|
- **Mutual Benefit**: Growth that benefits both new and existing community members
|
||||||
- **Sustainable Practices**: Growth approaches that support long-term community health
|
- **Sustainable Practices**: Growth approaches that support long-term community health
|
||||||
- **Inclusive Representation**: Prioritizing diversity and representation in growth efforts
|
- **Inclusive Representation**: Prioritising diversity and representation in growth efforts
|
||||||
|
|
||||||
**Anti-Exploitation Stance:**
|
**Anti-Exploitation Stance:**
|
||||||
- **No Predatory Recruitment**: Reject targeting vulnerable individuals for growth purposes
|
- **No Predatory Recruitment**: Reject targeting vulnerable individuals for growth purposes
|
||||||
@@ -26,20 +26,20 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Boundary Respect**: Recognition of personal and cultural boundaries in outreach efforts
|
- **Boundary Respect**: Recognition of personal and cultural boundaries in outreach efforts
|
||||||
- **Community Autonomy**: Support for community self-determination and organic growth
|
- **Community Autonomy**: Support for community self-determination and organic growth
|
||||||
|
|
||||||
### 1.3 Integration with Community Values
|
### 1.3. Integration with Community Values
|
||||||
|
|
||||||
**Social Justice Alignment:**
|
**Social Justice Alignment:**
|
||||||
- **Anti-Oppression Focus**: Growth efforts that actively support marginalized communities
|
- **Anti-Oppression Focus**: Growth efforts that actively support marginalised communities
|
||||||
- **Accessibility Prioritization**: Ensuring growth includes people with diverse abilities and needs
|
- **Accessibility Prioritization**: Ensuring growth includes people with diverse abilities and needs
|
||||||
- **Economic Justice**: Growth that doesn't exclude people based on economic circumstances
|
- **Economic Justice**: Growth that doesn't exclude people based on economic circumstances
|
||||||
- **Environmental Responsibility**: Sustainable growth practices that minimize environmental impact
|
- **Environmental Responsibility**: Sustainable growth practices that minimise environmental impact
|
||||||
- **Democratic Participation**: Growth that strengthens rather than dilutes community democracy
|
- **Democratic Participation**: Growth that strengthens rather than dilutes community democracy
|
||||||
|
|
||||||
## 2. INDIVIDUAL MEMBER GROWTH CONTRIBUTIONS
|
## 2. INDIVIDUAL MEMBER GROWTH CONTRIBUTIONS
|
||||||
|
|
||||||
### 2.1 Personal Network Outreach
|
### 2.1. Personal Network Outreach
|
||||||
|
|
||||||
#### 2.1.1 Authentic Relationship Building
|
#### 2.1.1. Authentic Relationship Building
|
||||||
|
|
||||||
**Effective Outreach Approaches:**
|
**Effective Outreach Approaches:**
|
||||||
- **Share Personal Experiences**: Talk about what the community means to you personally
|
- **Share Personal Experiences**: Talk about what the community means to you personally
|
||||||
@@ -55,7 +55,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Support Integration**: Help new members find their place and feel welcome
|
- **Support Integration**: Help new members find their place and feel welcome
|
||||||
- **Long-Term Perspective**: Focus on sustainable relationships rather than quick conversions
|
- **Long-Term Perspective**: Focus on sustainable relationships rather than quick conversions
|
||||||
|
|
||||||
#### 2.1.2 Community Representation
|
#### 2.1.2. Community Representation
|
||||||
|
|
||||||
**Positive Community Representation:**
|
**Positive Community Representation:**
|
||||||
- **Authentic Engagement**: Represent the community accurately and honestly
|
- **Authentic Engagement**: Represent the community accurately and honestly
|
||||||
@@ -71,9 +71,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **No Exploitation**: Don't target people in vulnerable situations for recruitment purposes
|
- **No Exploitation**: Don't target people in vulnerable situations for recruitment purposes
|
||||||
- **Privacy Respect**: Don't share private information about community members or discussions
|
- **Privacy Respect**: Don't share private information about community members or discussions
|
||||||
|
|
||||||
### 2.2 Content Creation and Sharing
|
### 2.2. Content Creation and Sharing
|
||||||
|
|
||||||
#### 2.2.1 Values-Aligned Content
|
#### 2.2.1. Values-Aligned Content
|
||||||
|
|
||||||
**Effective Content Strategies:**
|
**Effective Content Strategies:**
|
||||||
- **Educational Resources**: Create content that educates about issues the community cares about
|
- **Educational Resources**: Create content that educates about issues the community cares about
|
||||||
@@ -90,7 +90,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **GitHub**: Technical contributions and documentation that showcase community technical work
|
- **GitHub**: Technical contributions and documentation that showcase community technical work
|
||||||
- **YouTube**: Educational or informational content that represents community values
|
- **YouTube**: Educational or informational content that represents community values
|
||||||
|
|
||||||
#### 2.2.2 Ethical Content Practices
|
#### 2.2.2. Ethical Content Practices
|
||||||
|
|
||||||
**Content Quality Standards:**
|
**Content Quality Standards:**
|
||||||
- **Accuracy**: Ensure all content is accurate and well-researched
|
- **Accuracy**: Ensure all content is accurate and well-researched
|
||||||
@@ -106,9 +106,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Respect Boundaries**: Don't share private community discussions or member information
|
- **Respect Boundaries**: Don't share private community discussions or member information
|
||||||
- **Quality Control**: Don't create low-quality content that reflects poorly on the community
|
- **Quality Control**: Don't create low-quality content that reflects poorly on the community
|
||||||
|
|
||||||
### 2.3 Event Participation and Hosting
|
### 2.3. Event Participation and Hosting
|
||||||
|
|
||||||
#### 2.3.1 Community Event Involvement
|
#### 2.3.1. Community Event Involvement
|
||||||
|
|
||||||
**Effective Event Participation:**
|
**Effective Event Participation:**
|
||||||
- **Active Engagement**: Participate meaningfully in community events and activities
|
- **Active Engagement**: Participate meaningfully in community events and activities
|
||||||
@@ -124,7 +124,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Educational Component**: Include educational elements that support community growth
|
- **Educational Component**: Include educational elements that support community growth
|
||||||
- **Community Benefit**: Focus on events that benefit both community and broader society
|
- **Community Benefit**: Focus on events that benefit both community and broader society
|
||||||
|
|
||||||
#### 2.3.2 External Event Representation
|
#### 2.3.2. External Event Representation
|
||||||
|
|
||||||
**Community Representation at External Events:**
|
**Community Representation at External Events:**
|
||||||
- **Conference Participation**: Represent the community at relevant conferences and gatherings
|
- **Conference Participation**: Represent the community at relevant conferences and gatherings
|
||||||
@@ -142,25 +142,25 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
|
|
||||||
## 3. ORGANIZATIONAL GROWTH STRATEGIES
|
## 3. ORGANIZATIONAL GROWTH STRATEGIES
|
||||||
|
|
||||||
### 3.1 Partnership Development
|
### 3.1. Partnership Development
|
||||||
|
|
||||||
#### 3.1.1 Values-Aligned Partnerships
|
#### 3.1.1. Values-Aligned Partnerships
|
||||||
|
|
||||||
**Strategic Partnership Criteria:**
|
**Strategic Partnership Criteria:**
|
||||||
- **Shared Values**: Partner organizations must share core social justice values
|
- **Shared Values**: Partner organisations must share core social justice values
|
||||||
- **Complementary Mission**: Partnerships should enhance rather than compromise community mission
|
- **Complementary Mission**: Partnerships should enhance rather than compromise community mission
|
||||||
- **Mutual Benefit**: Partnerships should benefit all involved parties
|
- **Mutual Benefit**: Partnerships should benefit all involved parties
|
||||||
- **Community Input**: Community members should have input on significant partnership decisions
|
- **Community Input**: Community members should have input on significant partnership decisions
|
||||||
- **Ethical Practices**: Partner organizations must demonstrate ethical practices and accountability
|
- **Ethical Practices**: Partner organisations must demonstrate ethical practices and accountability
|
||||||
|
|
||||||
**Partnership Development Process:**
|
**Partnership Development Process:**
|
||||||
- **Due Diligence**: Thorough research on potential partner organizations and their practices
|
- **Due Diligence**: Thorough research on potential partner organisations and their practices
|
||||||
- **Community Discussion**: Open community discussion about proposed partnerships
|
- **Community Discussion**: Open community discussion about proposed partnerships
|
||||||
- **Trial Collaboration**: Start with small collaborative projects before formal partnerships
|
- **Trial Collaboration**: Start with small collaborative projects before formal partnerships
|
||||||
- **Regular Evaluation**: Ongoing evaluation of partnership effectiveness and alignment
|
- **Regular Evaluation**: Ongoing evaluation of partnership effectiveness and alignment
|
||||||
- **Exit Strategies**: Clear processes for ending partnerships that no longer serve community values
|
- **Exit Strategies**: Clear processes for ending partnerships that no longer serve community values
|
||||||
|
|
||||||
#### 3.1.2 Cross-Platform Collaboration
|
#### 3.1.2. Cross-Platform Collaboration
|
||||||
|
|
||||||
**Multi-Platform Growth Strategies:**
|
**Multi-Platform Growth Strategies:**
|
||||||
- **Discord Integration**: Leverage Discord community for growth across other platforms
|
- **Discord Integration**: Leverage Discord community for growth across other platforms
|
||||||
@@ -176,12 +176,12 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Community Building**: Focus on building authentic communities rather than just followers
|
- **Community Building**: Focus on building authentic communities rather than just followers
|
||||||
- **Cross-Pollination**: Encourage organic connections between platform communities
|
- **Cross-Pollination**: Encourage organic connections between platform communities
|
||||||
|
|
||||||
### 3.2 Targeted Outreach and Recruitment
|
### 3.2. Targeted Outreach and Recruitment
|
||||||
|
|
||||||
#### 3.2.1 Diversity-Centred Recruitment
|
#### 3.2.1. Diversity-Centred Recruitment
|
||||||
|
|
||||||
**Priority Communities:**
|
**Priority Communities:**
|
||||||
- **Marginalized Identities**: Prioritize outreach to communities that are underrepresented in tech and social justice spaces
|
- **Marginalised Identities**: Prioritise outreach to communities that are underrepresented in tech and social justice spaces
|
||||||
- **Geographic Diversity**: Seek geographic diversity while respecting cultural differences
|
- **Geographic Diversity**: Seek geographic diversity while respecting cultural differences
|
||||||
- **Economic Accessibility**: Ensure growth includes people from diverse economic backgrounds
|
- **Economic Accessibility**: Ensure growth includes people from diverse economic backgrounds
|
||||||
- **Accessibility Needs**: Actively recruit people with disabilities and diverse accessibility needs
|
- **Accessibility Needs**: Actively recruit people with disabilities and diverse accessibility needs
|
||||||
@@ -192,13 +192,13 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Language Accessibility**: Provide materials in multiple languages when possible
|
- **Language Accessibility**: Provide materials in multiple languages when possible
|
||||||
- **Cultural Sensitivity**: Respect cultural differences in communication and participation styles
|
- **Cultural Sensitivity**: Respect cultural differences in communication and participation styles
|
||||||
- **Community Liaisons**: Work with community members who have connections to underrepresented communities
|
- **Community Liaisons**: Work with community members who have connections to underrepresented communities
|
||||||
- **Safe Space Creation**: Ensure outreach creates genuinely safe spaces for marginalized individuals
|
- **Safe Space Creation**: Ensure outreach creates genuinely safe spaces for marginalised individuals
|
||||||
|
|
||||||
#### 3.2.2 Interest-Based Community Building
|
#### 3.2.2. Interest-Based Community Building
|
||||||
|
|
||||||
**Skill and Interest Alignment:**
|
**Skill and Interest Alignment:**
|
||||||
- **Technical Communities**: Outreach to technical communities interested in ethical technology
|
- **Technical Communities**: Outreach to technical communities interested in ethical technology
|
||||||
- **Social Justice Organizations**: Connection with organizations working on related social justice issues
|
- **Social Justice Organizations**: Connection with organisations working on related social justice issues
|
||||||
- **Gaming Communities**: Authentic participation in gaming communities with shared values
|
- **Gaming Communities**: Authentic participation in gaming communities with shared values
|
||||||
- **Educational Institutions**: Outreach to educational communities interested in community building
|
- **Educational Institutions**: Outreach to educational communities interested in community building
|
||||||
- **Professional Networks**: Engagement with professional networks focused on ethical practices
|
- **Professional Networks**: Engagement with professional networks focused on ethical practices
|
||||||
@@ -210,15 +210,15 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Capacity Assessment**: Assess community capacity for integrating new members effectively
|
- **Capacity Assessment**: Assess community capacity for integrating new members effectively
|
||||||
- **Resource Planning**: Ensure adequate resources for supporting community growth
|
- **Resource Planning**: Ensure adequate resources for supporting community growth
|
||||||
|
|
||||||
### 3.3 Brand Development and Messaging
|
### 3.3. Brand Development and Messaging
|
||||||
|
|
||||||
#### 3.3.1 Community Identity and Values Communication
|
#### 3.3.1. Community Identity and Values Communication
|
||||||
|
|
||||||
**Brand Messaging Principles:**
|
**Brand Messaging Principles:**
|
||||||
- **Authenticity**: All messaging should authentically represent community culture and values
|
- **Authenticity**: All messaging should authentically represent community culture and values
|
||||||
- **Accessibility**: Communication should be accessible to diverse audiences
|
- **Accessibility**: Communication should be accessible to diverse audiences
|
||||||
- **Inclusivity**: Messaging should welcome diverse participation and representation
|
- **Inclusivity**: Messaging should welcome diverse participation and representation
|
||||||
- **Impact Focus**: Emphasize concrete community impact and social justice work
|
- **Impact Focus**: Emphasise concrete community impact and social justice work
|
||||||
- **Community Voice**: Brand should reflect diverse community voices rather than single perspectives
|
- **Community Voice**: Brand should reflect diverse community voices rather than single perspectives
|
||||||
|
|
||||||
**Consistent Messaging Across Platforms:**
|
**Consistent Messaging Across Platforms:**
|
||||||
@@ -228,7 +228,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Accessibility Information**: Clear information about community accessibility and inclusion efforts
|
- **Accessibility Information**: Clear information about community accessibility and inclusion efforts
|
||||||
- **Participation Options**: Clear information about different ways to participate and contribute
|
- **Participation Options**: Clear information about different ways to participate and contribute
|
||||||
|
|
||||||
#### 3.3.2 Marketing Ethics and Transparency
|
#### 3.3.2. Marketing Ethics and Transparency
|
||||||
|
|
||||||
**Ethical Marketing Practices:**
|
**Ethical Marketing Practices:**
|
||||||
- **Honest Representation**: Never misrepresent community culture, benefits, or expectations
|
- **Honest Representation**: Never misrepresent community culture, benefits, or expectations
|
||||||
@@ -246,9 +246,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
|
|
||||||
## 4. COMMUNITY INTEGRATION AND SUPPORT
|
## 4. COMMUNITY INTEGRATION AND SUPPORT
|
||||||
|
|
||||||
### 4.1 New Member Onboarding
|
### 4.1. New Member Onboarding
|
||||||
|
|
||||||
#### 4.1.1 Welcoming and Orientation Process
|
#### 4.1.1. Welcoming and Orientation Process
|
||||||
|
|
||||||
**Comprehensive Onboarding:**
|
**Comprehensive Onboarding:**
|
||||||
- **Welcome Systems**: Systematic welcome processes for new members across all platforms
|
- **Welcome Systems**: Systematic welcome processes for new members across all platforms
|
||||||
@@ -264,7 +264,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Flexible Engagement**: Recognition that engagement levels and styles vary among community members
|
- **Flexible Engagement**: Recognition that engagement levels and styles vary among community members
|
||||||
- **Support Systems**: Connection to appropriate support systems and resources
|
- **Support Systems**: Connection to appropriate support systems and resources
|
||||||
|
|
||||||
#### 4.1.2 Community Culture Integration
|
#### 4.1.2. Community Culture Integration
|
||||||
|
|
||||||
**Cultural Assimilation Support:**
|
**Cultural Assimilation Support:**
|
||||||
- **Community Norms**: Education about community norms, expectations, and culture
|
- **Community Norms**: Education about community norms, expectations, and culture
|
||||||
@@ -280,9 +280,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Leadership Development**: Pathways for new members to develop leadership skills and take on responsibilities
|
- **Leadership Development**: Pathways for new members to develop leadership skills and take on responsibilities
|
||||||
- **Community Investment**: Support for new members to develop investment in community success
|
- **Community Investment**: Support for new members to develop investment in community success
|
||||||
|
|
||||||
### 4.2 Retention and Engagement
|
### 4.2. Retention and Engagement
|
||||||
|
|
||||||
#### 4.2.1 Sustainable Participation
|
#### 4.2.1. Sustainable Participation
|
||||||
|
|
||||||
**Long-Term Engagement Strategies:**
|
**Long-Term Engagement Strategies:**
|
||||||
- **Meaningful Participation**: Opportunities for community members to contribute meaningfully
|
- **Meaningful Participation**: Opportunities for community members to contribute meaningfully
|
||||||
@@ -298,7 +298,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Sustainable Volunteerism**: Sustainable approaches to volunteer engagement and responsibility
|
- **Sustainable Volunteerism**: Sustainable approaches to volunteer engagement and responsibility
|
||||||
- **Well-Being Priority**: Prioritization of member well-being over community productivity
|
- **Well-Being Priority**: Prioritization of member well-being over community productivity
|
||||||
|
|
||||||
#### 4.2.2 Community Evolution and Adaptation
|
#### 4.2.2. Community Evolution and Adaptation
|
||||||
|
|
||||||
**Growth-Responsive Community Development:**
|
**Growth-Responsive Community Development:**
|
||||||
- **Culture Preservation**: Maintaining community culture and values while accommodating growth
|
- **Culture Preservation**: Maintaining community culture and values while accommodating growth
|
||||||
@@ -316,9 +316,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
|
|
||||||
## 5. SUSTAINABILITY AND IMPACT MEASUREMENT
|
## 5. SUSTAINABILITY AND IMPACT MEASUREMENT
|
||||||
|
|
||||||
### 5.1 Growth Sustainability
|
### 5.1. Growth Sustainability
|
||||||
|
|
||||||
#### 5.1.1 Resource Management and Planning
|
#### 5.1.1. Resource Management and Planning
|
||||||
|
|
||||||
**Capacity Planning:**
|
**Capacity Planning:**
|
||||||
- **Resource Assessment**: Regular assessment of community capacity to support new members
|
- **Resource Assessment**: Regular assessment of community capacity to support new members
|
||||||
@@ -334,7 +334,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Cultural Sustainability**: Preservation of community culture and values during growth
|
- **Cultural Sustainability**: Preservation of community culture and values during growth
|
||||||
- **Member Well-Being**: Prioritization of member well-being in growth planning
|
- **Member Well-Being**: Prioritization of member well-being in growth planning
|
||||||
|
|
||||||
#### 5.1.2 Growth Rate Management
|
#### 5.1.2. Growth Rate Management
|
||||||
|
|
||||||
**Sustainable Growth Pacing:**
|
**Sustainable Growth Pacing:**
|
||||||
- **Organic Growth Priority**: Prioritization of organic growth over rapid expansion
|
- **Organic Growth Priority**: Prioritization of organic growth over rapid expansion
|
||||||
@@ -343,9 +343,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Resource Alignment**: Growth that aligns with available resources and support capacity
|
- **Resource Alignment**: Growth that aligns with available resources and support capacity
|
||||||
- **Community Input**: Community input on appropriate growth rates and targets
|
- **Community Input**: Community input on appropriate growth rates and targets
|
||||||
|
|
||||||
### 5.2 Impact Assessment and Measurement
|
### 5.2. Impact Assessment and Measurement
|
||||||
|
|
||||||
#### 5.2.1 Community Health Metrics
|
#### 5.2.1. Community Health Metrics
|
||||||
|
|
||||||
**Quantitative Measures:**
|
**Quantitative Measures:**
|
||||||
- **Member Engagement**: Measurement of member engagement and participation across platforms
|
- **Member Engagement**: Measurement of member engagement and participation across platforms
|
||||||
@@ -361,7 +361,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Conflict Resolution**: Analysis of conflict resolution effectiveness and community harmony
|
- **Conflict Resolution**: Analysis of conflict resolution effectiveness and community harmony
|
||||||
- **Values Integration**: Assessment of how well community values are integrated in daily practice
|
- **Values Integration**: Assessment of how well community values are integrated in daily practice
|
||||||
|
|
||||||
#### 5.2.2 External Impact Measurement
|
#### 5.2.2. External Impact Measurement
|
||||||
|
|
||||||
**Social Justice Impact:**
|
**Social Justice Impact:**
|
||||||
- **Advocacy Effectiveness**: Measurement of community advocacy and social justice impact
|
- **Advocacy Effectiveness**: Measurement of community advocacy and social justice impact
|
||||||
@@ -379,9 +379,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
|
|
||||||
## 6. ACCOUNTABILITY AND CONTINUOUS IMPROVEMENT
|
## 6. ACCOUNTABILITY AND CONTINUOUS IMPROVEMENT
|
||||||
|
|
||||||
### 6.1 Growth Practice Evaluation
|
### 6.1. Growth Practice Evaluation
|
||||||
|
|
||||||
#### 6.1.1 Regular Assessment and Review
|
#### 6.1.1. Regular Assessment and Review
|
||||||
|
|
||||||
**Growth Strategy Review:**
|
**Growth Strategy Review:**
|
||||||
- **Quarterly Assessments**: Regular quarterly review of growth strategies and effectiveness
|
- **Quarterly Assessments**: Regular quarterly review of growth strategies and effectiveness
|
||||||
@@ -397,7 +397,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Innovation Integration**: Integration of innovative approaches to community growth
|
- **Innovation Integration**: Integration of innovative approaches to community growth
|
||||||
- **Learning Documentation**: Documentation of lessons learned for future growth planning
|
- **Learning Documentation**: Documentation of lessons learned for future growth planning
|
||||||
|
|
||||||
#### 6.1.2 Community Accountability
|
#### 6.1.2. Community Accountability
|
||||||
|
|
||||||
**Transparent Reporting:**
|
**Transparent Reporting:**
|
||||||
- **Growth Reports**: Regular reports to community on growth activities and results
|
- **Growth Reports**: Regular reports to community on growth activities and results
|
||||||
@@ -413,9 +413,9 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Conflict Resolution**: Processes for resolving conflicts related to growth practices
|
- **Conflict Resolution**: Processes for resolving conflicts related to growth practices
|
||||||
- **Value Enforcement**: Enforcement of community values in all growth activities
|
- **Value Enforcement**: Enforcement of community values in all growth activities
|
||||||
|
|
||||||
### 6.2 Continuous Learning and Innovation
|
### 6.2. Continuous Learning and Innovation
|
||||||
|
|
||||||
#### 6.2.1 Best Practice Development
|
#### 6.2.1. Best Practice Development
|
||||||
|
|
||||||
**Internal Learning:**
|
**Internal Learning:**
|
||||||
- **Experience Documentation**: Documentation of growth experiences and lessons learned
|
- **Experience Documentation**: Documentation of growth experiences and lessons learned
|
||||||
@@ -431,7 +431,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
- **Technology Integration**: Appropriate integration of new technologies for community growth
|
- **Technology Integration**: Appropriate integration of new technologies for community growth
|
||||||
- **Innovation Adoption**: Adoption of innovative approaches to ethical community building
|
- **Innovation Adoption**: Adoption of innovative approaches to ethical community building
|
||||||
|
|
||||||
#### 6.2.2 Future Planning and Vision
|
#### 6.2.2. Future Planning and Vision
|
||||||
|
|
||||||
**Long-Term Vision Development:**
|
**Long-Term Vision Development:**
|
||||||
- **Community Vision**: Development of long-term vision for community growth and impact
|
- **Community Vision**: Development of long-term vision for community growth and impact
|
||||||
@@ -449,8 +449,5 @@ This Community Growth Policy establishes ethical guidelines for how community me
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Community Growth Policy establishes ethical guidelines for sustainable, values-aligned community growth. It works in conjunction with our Community Support Policy, Crisis and Mental Health Management Policy, and staff training materials to ensure holistic community development. All growth activities should prioritize quality relationships, authentic engagement, and alignment with social justice values over numerical metrics or rapid expansion.*
|
*This Community Growth Policy establishes ethical guidelines for sustainable, values-aligned community growth. It works in conjunction with our Community Support Policy, Crisis and Mental Health Management Policy, and staff training materials to ensure holistic community development. All growth activities should prioritise quality relationships, authentic engagement, and alignment with social justice values over numerical metrics or rapid expansion.*
|
||||||
|
|
||||||
**Document Version**: 1.0
|
|
||||||
**Last Updated**: 25 September 2025
|
|
||||||
**Next Review Date**: 25 March 2026
|
|
||||||
@@ -6,11 +6,11 @@ title: Community Support Policy
|
|||||||
|
|
||||||
## 1. POLICY OVERVIEW AND PURPOSE
|
## 1. POLICY OVERVIEW AND PURPOSE
|
||||||
|
|
||||||
### 1.1 Policy Statement
|
### 1.1. Policy Statement
|
||||||
|
|
||||||
This Community Support Policy establishes the framework for how community members can both seek and provide support within our community ecosystem. This policy is designed to create a safe, inclusive, and mutually supportive environment that honours our values of social justice, accessibility, and community empowerment while maintaining appropriate boundaries and safety standards.
|
This Community Support Policy establishes the framework for how community members can both seek and provide support within our community ecosystem. This policy is designed to create a safe, inclusive, and mutually supportive environment that honours our values of social justice, accessibility, and community empowerment while maintaining appropriate boundaries and safety standards.
|
||||||
|
|
||||||
### 1.2 Integration with Community Values
|
### 1.2. Integration with Community Values
|
||||||
|
|
||||||
**Core Principles:**
|
**Core Principles:**
|
||||||
- **Mutual Support**: Community members support each other through shared experiences and knowledge
|
- **Mutual Support**: Community members support each other through shared experiences and knowledge
|
||||||
@@ -20,7 +20,7 @@ This Community Support Policy establishes the framework for how community member
|
|||||||
- **Safety First**: Protection of vulnerable community members and support providers
|
- **Safety First**: Protection of vulnerable community members and support providers
|
||||||
- **Cultural Responsiveness**: Respect for diverse cultural approaches to support and healing
|
- **Cultural Responsiveness**: Respect for diverse cultural approaches to support and healing
|
||||||
|
|
||||||
### 1.3 Scope and Application
|
### 1.3. Scope and Application
|
||||||
|
|
||||||
This policy applies to all forms of support exchange within our community platforms, including:
|
This policy applies to all forms of support exchange within our community platforms, including:
|
||||||
- Discord channels and direct messages
|
- Discord channels and direct messages
|
||||||
@@ -34,9 +34,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
## 2. SEEKING SUPPORT WITHIN THE COMMUNITY
|
## 2. SEEKING SUPPORT WITHIN THE COMMUNITY
|
||||||
|
|
||||||
### 2.1 Types of Community Support Available
|
### 2.1. Types of Community Support Available
|
||||||
|
|
||||||
#### 2.1.1 Peer Support Categories
|
#### 2.1.1. Peer Support Categories
|
||||||
|
|
||||||
**Emotional and Social Support:**
|
**Emotional and Social Support:**
|
||||||
- Listening and empathy from community members with shared experiences
|
- Listening and empathy from community members with shared experiences
|
||||||
@@ -67,11 +67,11 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- Accessibility assistance and accommodation support
|
- Accessibility assistance and accommodation support
|
||||||
- Platform-specific guidance and orientation
|
- Platform-specific guidance and orientation
|
||||||
|
|
||||||
#### 2.1.2 Specialized Support Areas
|
#### 2.1.2. Specialized Support Areas
|
||||||
|
|
||||||
**Identity-Based Support:**
|
**Identity-Based Support:**
|
||||||
- Support groups for specific identities and experiences
|
- Support groups for specific identities and experiences
|
||||||
- Culturally responsive support for marginalized communities
|
- Culturally responsive support for marginalised communities
|
||||||
- LGBTQ+ affirming support and resources
|
- LGBTQ+ affirming support and resources
|
||||||
- Neurodiversity-affirming spaces and assistance
|
- Neurodiversity-affirming spaces and assistance
|
||||||
- Support for survivors of various forms of trauma
|
- Support for survivors of various forms of trauma
|
||||||
@@ -97,13 +97,13 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- API documentation and implementation guidance
|
- API documentation and implementation guidance
|
||||||
- Bug triage and feature development collaboration
|
- Bug triage and feature development collaboration
|
||||||
|
|
||||||
### 2.2 How to Seek Support
|
### 2.2. How to Seek Support
|
||||||
|
|
||||||
#### 2.2.1 Identifying Appropriate Support Channels
|
#### 2.2.1. Identifying Appropriate Support Channels
|
||||||
|
|
||||||
**Platform-Specific Guidelines:**
|
**Platform-Specific Guidelines:**
|
||||||
- **Discord**: Use designated support channels (#general-support, #tech-help) or reach out to trusted community members
|
- **Discord**: Use designated support channels (#general-support, #tech-help) or reach out to trusted community members
|
||||||
- **Forums**: Create posts in appropriate categories with clear, descriptive titles
|
- **Discord Forums**: Create posts in appropriate forum channels with clear, descriptive titles
|
||||||
- **Reddit**: Utilize community-specific support threads and appropriate flair
|
- **Reddit**: Utilize community-specific support threads and appropriate flair
|
||||||
- **GitHub**: Use issue templates for bug reports, feature requests, and technical support
|
- **GitHub**: Use issue templates for bug reports, feature requests, and technical support
|
||||||
- **Social Media**: Engage appropriately with community hashtags and threads
|
- **Social Media**: Engage appropriately with community hashtags and threads
|
||||||
@@ -117,7 +117,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Show Appreciation**: Acknowledge and thank those who provide support
|
- **Show Appreciation**: Acknowledge and thank those who provide support
|
||||||
- **Follow Up**: Update the community on resolution or continued needs when appropriate
|
- **Follow Up**: Update the community on resolution or continued needs when appropriate
|
||||||
|
|
||||||
#### 2.2.2 Technical Support Specific Guidelines
|
#### 2.2.2. Technical Support Specific Guidelines
|
||||||
|
|
||||||
**For Product and Development Issues:**
|
**For Product and Development Issues:**
|
||||||
- **Include System Information**: Provide relevant system details (OS, browser version, device type)
|
- **Include System Information**: Provide relevant system details (OS, browser version, device type)
|
||||||
@@ -129,14 +129,14 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Expected vs Actual**: Clearly describe what you expected to happen versus what actually occurred
|
- **Expected vs Actual**: Clearly describe what you expected to happen versus what actually occurred
|
||||||
|
|
||||||
**Best Practices for Technical Support Requests:**
|
**Best Practices for Technical Support Requests:**
|
||||||
- **Use Appropriate Templates**: Follow issue templates or forum formats when available
|
- **Use Appropriate Templates**: Follow issue templates or discussion formats when available
|
||||||
- **Search Existing Issues**: Check if your issue has already been reported or resolved
|
- **Search Existing Issues**: Check if your issue has already been reported or resolved
|
||||||
- **One Issue Per Request**: Keep support requests focused on a single problem
|
- **One Issue Per Request**: Keep support requests focused on a single problem
|
||||||
- **Provide Screenshots**: Include screenshots or screen recordings when they help illustrate the issue
|
- **Provide Screenshots**: Include screenshots or screen recordings when they help illustrate the issue
|
||||||
- **Test Environment**: Specify if you're using development, staging, or production environments
|
- **Test Environment**: Specify if you're using development, staging, or production environments
|
||||||
- **Recent Changes**: Note any recent changes to your setup that might be related to the issue
|
- **Recent Changes**: Note any recent changes to your setup that might be related to the issue
|
||||||
|
|
||||||
#### 2.2.3 Emergency and Crisis Support
|
#### 2.2.3. Emergency and Crisis Support
|
||||||
|
|
||||||
**Important Limitations:**
|
**Important Limitations:**
|
||||||
- Community members are **NOT** mental health professionals
|
- Community members are **NOT** mental health professionals
|
||||||
@@ -151,9 +151,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- Integration with our Crisis and Mental Health Management Policy
|
- Integration with our Crisis and Mental Health Management Policy
|
||||||
- Resource databases for professional services and emergency support
|
- Resource databases for professional services and emergency support
|
||||||
|
|
||||||
### 2.3 Receiving Support Effectively
|
### 2.3. Receiving Support Effectively
|
||||||
|
|
||||||
#### 2.3.1 Engagement Guidelines
|
#### 2.3.1. Engagement Guidelines
|
||||||
|
|
||||||
**Active Participation:**
|
**Active Participation:**
|
||||||
- **Communicate Clearly**: Share what you need and what would be helpful
|
- **Communicate Clearly**: Share what you need and what would be helpful
|
||||||
@@ -168,19 +168,19 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Report Concerns**: If support interactions become inappropriate, contact staff immediately
|
- **Report Concerns**: If support interactions become inappropriate, contact staff immediately
|
||||||
- **Protect Others' Privacy**: Respect the privacy of others who may be mentioned in your support requests
|
- **Protect Others' Privacy**: Respect the privacy of others who may be mentioned in your support requests
|
||||||
|
|
||||||
#### 2.3.2 Managing Multiple Support Sources
|
#### 2.3.2. Managing Multiple Support Sources
|
||||||
|
|
||||||
**Coordination Strategies:**
|
**Coordination Strategies:**
|
||||||
- **Professional Services First**: Prioritize professional mental health, medical, or legal services when needed
|
- **Professional Services First**: Prioritise professional mental health, medical, or legal services when needed
|
||||||
- **Community Support as Supplement**: Use community support to complement, not replace, professional services
|
- **Community Support as Supplement**: Use community support to complement, not replace, professional services
|
||||||
- **Avoid Overwhelming Supporters**: Be mindful of the capacity and boundaries of community volunteers
|
- **Avoid Overwhelming Supporters**: Be mindful of the capacity and boundaries of community volunteers
|
||||||
- **Update Supporters**: Let community supporters know when situations change or resolve
|
- **Update Supporters**: Let community supporters know when situations change or resolve
|
||||||
|
|
||||||
## 3. PROVIDING SUPPORT TO COMMUNITY MEMBERS
|
## 3. PROVIDING SUPPORT TO COMMUNITY MEMBERS
|
||||||
|
|
||||||
### 3.1 Peer Support Responsibilities and Boundaries
|
### 3.1. Peer Support Responsibilities and Boundaries
|
||||||
|
|
||||||
#### 3.1.1 Role Definition and Limitations
|
#### 3.1.1. Role Definition and Limitations
|
||||||
|
|
||||||
**What Peer Support IS:**
|
**What Peer Support IS:**
|
||||||
- Sharing personal experiences and what has worked for you
|
- Sharing personal experiences and what has worked for you
|
||||||
@@ -201,7 +201,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- Crisis intervention or emergency response services
|
- Crisis intervention or emergency response services
|
||||||
- Solutions to complex problems requiring professional expertise
|
- Solutions to complex problems requiring professional expertise
|
||||||
|
|
||||||
#### 3.1.2 Professional Boundary Maintenance
|
#### 3.1.2. Professional Boundary Maintenance
|
||||||
|
|
||||||
**Clear Communication About Limitations:**
|
**Clear Communication About Limitations:**
|
||||||
- Always clarify that you are not a professional service provider
|
- Always clarify that you are not a professional service provider
|
||||||
@@ -210,16 +210,16 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- Be honest about your own knowledge limitations and experience boundaries
|
- Be honest about your own knowledge limitations and experience boundaries
|
||||||
- Avoid giving advice outside your areas of experience or expertise
|
- Avoid giving advice outside your areas of experience or expertise
|
||||||
|
|
||||||
### 3.2 Best Practices for Providing Support
|
### 3.2. Best Practices for Providing Support
|
||||||
|
|
||||||
#### 3.2.1 Effective Support Techniques
|
#### 3.2.1. Effective Support Techniques
|
||||||
|
|
||||||
**Active Listening and Empathy:**
|
**Active Listening and Empathy:**
|
||||||
- **Listen First**: Focus on understanding before trying to solve or advise
|
- **Listen First**: Focus on understanding before trying to solve or advise
|
||||||
- **Validate Experiences**: Acknowledge the person's feelings and experiences as valid
|
- **Validate Experiences**: Acknowledge the person's feelings and experiences as valid
|
||||||
- **Ask Questions**: Clarify what type of support the person is seeking
|
- **Ask Questions**: Clarify what type of support the person is seeking
|
||||||
- **Reflect Understanding**: Demonstrate that you understand what they're sharing
|
- **Reflect Understanding**: Demonstrate that you understand what they're sharing
|
||||||
- **Avoid Minimizing**: Don't downplay or dismiss concerns, even if they seem minor to you
|
- **Avoid Minimising**: Don't downplay or dismiss concerns, even if they seem minor to you
|
||||||
|
|
||||||
**Resource Sharing and Information:**
|
**Resource Sharing and Information:**
|
||||||
- **Share Relevant Experience**: Offer insights from your own similar experiences when appropriate
|
- **Share Relevant Experience**: Offer insights from your own similar experiences when appropriate
|
||||||
@@ -228,14 +228,14 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Follow Up**: Check in when appropriate to see how things are going
|
- **Follow Up**: Check in when appropriate to see how things are going
|
||||||
- **Maintain Confidentiality**: Respect privacy and don't share personal details with others
|
- **Maintain Confidentiality**: Respect privacy and don't share personal details with others
|
||||||
|
|
||||||
#### 3.2.3 Technical Support Best Practices
|
#### 3.2.3. Technical Support Best Practices
|
||||||
|
|
||||||
**Troubleshooting Methodology:**
|
**Troubleshooting Methodology:**
|
||||||
- **Systematic Approach**: Work through problems systematically rather than jumping to conclusions
|
- **Systematic Approach**: Work through problems systematically rather than jumping to conclusions
|
||||||
- **Reproduce First**: Attempt to reproduce the issue yourself when possible
|
- **Reproduce First**: Attempt to reproduce the issue yourself when possible
|
||||||
- **Check Documentation**: Verify your understanding against official documentation
|
- **Check Documentation**: Verify your understanding against official documentation
|
||||||
- **Test Solutions**: Test suggested solutions in safe environments before recommending
|
- **Test Solutions**: Test suggested solutions in safe environments before recommending
|
||||||
- **Know Your Limits**: Recognize when issues exceed your technical knowledge
|
- **Know Your Limits**: Recognise when issues exceed your technical knowledge
|
||||||
- **Escalate Appropriately**: Direct complex technical issues to maintainers or core developers
|
- **Escalate Appropriately**: Direct complex technical issues to maintainers or core developers
|
||||||
|
|
||||||
**Code and Integration Support:**
|
**Code and Integration Support:**
|
||||||
@@ -249,12 +249,12 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
**API and Product Support:**
|
**API and Product Support:**
|
||||||
- **Version Compatibility**: Help users understand version requirements and compatibility
|
- **Version Compatibility**: Help users understand version requirements and compatibility
|
||||||
- **Rate Limiting**: Educate users about API rate limits and best practices
|
- **Rate Limiting**: Educate users about API rate limits and best practices
|
||||||
- **Authentication**: Assist with proper authentication and authorization setup
|
- **Authentication**: Assist with proper authentication and authorisation setup
|
||||||
- **Error Handling**: Help implement proper error handling and retry logic
|
- **Error Handling**: Help implement proper error handling and retry logic
|
||||||
- **Integration Patterns**: Share common integration patterns and examples
|
- **Integration Patterns**: Share common integration patterns and examples
|
||||||
- **Deprecation Awareness**: Keep users informed about deprecated features and migration paths
|
- **Deprecation Awareness**: Keep users informed about deprecated features and migration paths
|
||||||
|
|
||||||
#### 3.2.4 Cultural and Trauma-Informed Support
|
#### 3.2.4. Cultural and Trauma-Informed Support
|
||||||
|
|
||||||
**Cultural Responsiveness:**
|
**Cultural Responsiveness:**
|
||||||
- **Respect Differences**: Acknowledge that cultural backgrounds shape experiences and coping strategies
|
- **Respect Differences**: Acknowledge that cultural backgrounds shape experiences and coping strategies
|
||||||
@@ -264,15 +264,15 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Address Your Limitations**: Acknowledge when cultural differences are outside your experience
|
- **Address Your Limitations**: Acknowledge when cultural differences are outside your experience
|
||||||
|
|
||||||
**Trauma-Informed Approach:**
|
**Trauma-Informed Approach:**
|
||||||
- **Assume Possibility of Trauma**: Recognize that many people have experienced trauma
|
- **Assume Possibility of Trauma**: Recognise that many people have experienced trauma
|
||||||
- **Prioritize Safety**: Create interactions that feel safe and non-threatening
|
- **Prioritise Safety**: Create interactions that feel safe and non-threatening
|
||||||
- **Offer Choice and Control**: Let people make their own decisions about sharing and participation
|
- **Offer Choice and Control**: Let people make their own decisions about sharing and participation
|
||||||
- **Emphasize Collaboration**: Work with people rather than directing or controlling their experience
|
- **Emphasise Collaboration**: Work with people rather than directing or controlling their experience
|
||||||
- **Build Trust**: Be reliable, consistent, and honest in your interactions
|
- **Build Trust**: Be reliable, consistent, and honest in your interactions
|
||||||
|
|
||||||
### 3.3 Support Provider Self-Care and Sustainability
|
### 3.3. Support Provider Self-Care and Sustainability
|
||||||
|
|
||||||
#### 3.3.1 Managing Your Own Capacity
|
#### 3.3.1. Managing Your Own Capacity
|
||||||
|
|
||||||
**Setting Healthy Boundaries:**
|
**Setting Healthy Boundaries:**
|
||||||
- **Know Your Limits**: Be realistic about your time, energy, and emotional capacity
|
- **Know Your Limits**: Be realistic about your time, energy, and emotional capacity
|
||||||
@@ -283,32 +283,32 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
**Preventing Burnout:**
|
**Preventing Burnout:**
|
||||||
- **Distribute Support Load**: Encourage multiple people to provide support rather than taking everything on yourself
|
- **Distribute Support Load**: Encourage multiple people to provide support rather than taking everything on yourself
|
||||||
- **Recognize Warning Signs**: Know the signs of emotional exhaustion and burnout
|
- **Recognise Warning Signs**: Know the signs of emotional exhaustion and burnout
|
||||||
- **Practice Self-Care**: Maintain your own well-being through whatever practices work for you
|
- **Practice Self-Care**: Maintain your own well-being through whatever practices work for you
|
||||||
- **Professional Support**: Seek professional support for your own challenges when needed
|
- **Professional Support**: Seek professional support for your own challenges when needed
|
||||||
- **Community Among Supporters**: Connect with other support providers for mutual support
|
- **Community Among Supporters**: Connect with other support providers for mutual support
|
||||||
|
|
||||||
#### 3.3.2 Handling Difficult Support Situations
|
#### 3.3.2. Handling Difficult Support Situations
|
||||||
|
|
||||||
**When to Escalate to Staff:**
|
**When to Escalate to Staff:**
|
||||||
- **Safety Concerns**: Any indication of immediate danger to self or others
|
- **Safety Concerns**: Any indication of immediate danger to self or others
|
||||||
- **Harassment or Abuse**: Inappropriate behavior during support interactions
|
- **Harassment or Abuse**: Inappropriate behaviour during support interactions
|
||||||
- **Professional Service Needs**: Situations clearly requiring professional intervention
|
- **Professional Service Needs**: Situations clearly requiring professional intervention
|
||||||
- **Boundary Violations**: When support requests become inappropriate or overwhelming
|
- **Boundary Violations**: When support requests become inappropriate or overwhelming
|
||||||
- **Community Policy Violations**: Any behavior that violates community standards
|
- **Community Policy Violations**: Any behaviour that violates community standards
|
||||||
|
|
||||||
**Managing Challenging Interactions:**
|
**Managing Challenging Interactions:**
|
||||||
- **Stay Calm**: Maintain composure even when interactions become difficult
|
- **Stay Calm**: Maintain composure even when interactions become difficult
|
||||||
- **Redirect Appropriately**: Guide people to more appropriate resources when needed
|
- **Redirect Appropriately**: Guide people to more appropriate resources when needed
|
||||||
- **Document Concerns**: Keep records of concerning interactions for staff review
|
- **Document Concerns**: Keep records of concerning interactions for staff review
|
||||||
- **Seek Consultation**: Ask staff or experienced community members for guidance when unsure
|
- **Seek Consultation**: Ask staff or experienced community members for guidance when unsure
|
||||||
- **Protect Yourself**: Prioritize your own safety and well-being in all interactions
|
- **Protect Yourself**: Prioritise your own safety and well-being in all interactions
|
||||||
|
|
||||||
## 4. PLATFORM-SPECIFIC SUPPORT GUIDELINES
|
## 4. PLATFORM-SPECIFIC SUPPORT GUIDELINES
|
||||||
|
|
||||||
### 4.1 Discord Support Protocols
|
### 4.1. Discord Support Protocols
|
||||||
|
|
||||||
#### 4.1.1 Channel Organization and Usage
|
#### 4.1.1. Channel Organization and Usage
|
||||||
|
|
||||||
**Designated Support Channels:**
|
**Designated Support Channels:**
|
||||||
- **#support**: General questions and peer support requests
|
- **#support**: General questions and peer support requests
|
||||||
@@ -322,7 +322,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Escalation Protocols**: Know when and how to involve Discord moderators and staff
|
- **Escalation Protocols**: Know when and how to involve Discord moderators and staff
|
||||||
- **Privacy Protection**: Respect confidentiality while ensuring safety
|
- **Privacy Protection**: Respect confidentiality while ensuring safety
|
||||||
|
|
||||||
#### 4.1.2 Discord-Specific Safety Measures
|
#### 4.1.2. Discord-Specific Safety Measures
|
||||||
|
|
||||||
**Moderation Integration:**
|
**Moderation Integration:**
|
||||||
- **Staff Notification**: Clear processes for alerting staff to concerning situations
|
- **Staff Notification**: Clear processes for alerting staff to concerning situations
|
||||||
@@ -330,9 +330,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Evidence Preservation**: Proper documentation of problematic interactions
|
- **Evidence Preservation**: Proper documentation of problematic interactions
|
||||||
- **Community Protection**: Mechanisms for protecting vulnerable community members
|
- **Community Protection**: Mechanisms for protecting vulnerable community members
|
||||||
|
|
||||||
### 4.2 Forum and Reddit Support
|
### 4.2. Discord Forum Channels and Reddit Support
|
||||||
|
|
||||||
#### 4.2.1 Public Support Best Practices
|
#### 4.2.1. Public Support Best Practices
|
||||||
|
|
||||||
**Post Guidelines:**
|
**Post Guidelines:**
|
||||||
- **Descriptive Titles**: Clear titles that indicate the type of support needed
|
- **Descriptive Titles**: Clear titles that indicate the type of support needed
|
||||||
@@ -346,7 +346,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Resource Sharing**: Provide links to helpful resources and information
|
- **Resource Sharing**: Provide links to helpful resources and information
|
||||||
- **Respectful Disagreement**: Handle differing perspectives constructively
|
- **Respectful Disagreement**: Handle differing perspectives constructively
|
||||||
|
|
||||||
#### 4.2.2 Community Upvoting and Visibility
|
#### 4.2.2. Community Upvoting and Visibility
|
||||||
|
|
||||||
**Helpful Content Promotion:**
|
**Helpful Content Promotion:**
|
||||||
- **Upvote Helpful Responses**: Use voting systems to promote good support
|
- **Upvote Helpful Responses**: Use voting systems to promote good support
|
||||||
@@ -354,9 +354,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Community Curation**: Help ensure quality support content is visible
|
- **Community Curation**: Help ensure quality support content is visible
|
||||||
- **Constructive Feedback**: Provide feedback that improves support quality
|
- **Constructive Feedback**: Provide feedback that improves support quality
|
||||||
|
|
||||||
### 4.3 Professional Platform Support (LinkedIn, GitHub)
|
### 4.3. Professional Platform Support (LinkedIn, GitHub)
|
||||||
|
|
||||||
#### 4.3.1 Professional Context Considerations
|
#### 4.3.1. Professional Context Considerations
|
||||||
|
|
||||||
**LinkedIn Support:**
|
**LinkedIn Support:**
|
||||||
- **Professional Boundaries**: Maintain appropriate professional boundaries
|
- **Professional Boundaries**: Maintain appropriate professional boundaries
|
||||||
@@ -373,14 +373,14 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Learning Facilitation**: Supporting technical learning and development
|
- **Learning Facilitation**: Supporting technical learning and development
|
||||||
- **API Integration**: Assistance with integrating community APIs and services
|
- **API Integration**: Assistance with integrating community APIs and services
|
||||||
|
|
||||||
#### 4.3.2 Code-Specific Technical Support
|
#### 4.3.2. Code-Specific Technical Support
|
||||||
|
|
||||||
**Issue Management:**
|
**Issue Management:**
|
||||||
- **Issue Templates**: Use and help others use appropriate issue templates
|
- **Issue Templates**: Use and help others use appropriate issue templates
|
||||||
- **Label Usage**: Apply appropriate labels to categorize issues effectively
|
- **Label Usage**: Apply appropriate labels to categorise issues effectively
|
||||||
- **Milestone Tracking**: Help track issues against project milestones and releases
|
- **Milestone Tracking**: Help track issues against project milestones and releases
|
||||||
- **Duplicate Detection**: Identify and link duplicate issues to reduce fragmentation
|
- **Duplicate Detection**: Identify and link duplicate issues to reduce fragmentation
|
||||||
- **Triage Assistance**: Help maintainers triage and prioritize issues
|
- **Triage Assistance**: Help maintainers triage and prioritise issues
|
||||||
- **Resolution Documentation**: Document solutions and workarounds in issue comments
|
- **Resolution Documentation**: Document solutions and workarounds in issue comments
|
||||||
|
|
||||||
**Code Collaboration:**
|
**Code Collaboration:**
|
||||||
@@ -401,9 +401,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
## 5. SAFETY AND RISK MANAGEMENT
|
## 5. SAFETY AND RISK MANAGEMENT
|
||||||
|
|
||||||
### 5.1 Identifying and Managing Risk
|
### 5.1. Identifying and Managing Risk
|
||||||
|
|
||||||
#### 5.1.1 Risk Assessment for Support Situations
|
#### 5.1.1. Risk Assessment for Support Situations
|
||||||
|
|
||||||
**High-Risk Indicators:**
|
**High-Risk Indicators:**
|
||||||
- **Immediate Safety Concerns**: Threats of self-harm or harm to others
|
- **Immediate Safety Concerns**: Threats of self-harm or harm to others
|
||||||
@@ -422,13 +422,13 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Follow-Up Procedures**: Ongoing monitoring and support coordination
|
- **Follow-Up Procedures**: Ongoing monitoring and support coordination
|
||||||
- **Community Protection**: Measures to protect vulnerable community members
|
- **Community Protection**: Measures to protect vulnerable community members
|
||||||
|
|
||||||
#### 5.1.3 Technical Support Risk Management
|
#### 5.1.3. Technical Support Risk Management
|
||||||
|
|
||||||
**Security-Related Support Risks:**
|
**Security-Related Support Risks:**
|
||||||
- **Credential Exposure**: Prevent sharing of passwords, API keys, or other sensitive credentials in support channels
|
- **Credential Exposure**: Prevent sharing of passwords, API keys, or other sensitive credentials in support channels
|
||||||
- **Code Injection**: Be cautious of code suggestions that could introduce security vulnerabilities
|
- **Code Injection**: Be cautious of code suggestions that could introduce security vulnerabilities
|
||||||
- **Malicious Code**: Screen for and prevent sharing of potentially malicious code or links
|
- **Malicious Code**: Screen for and prevent sharing of potentially malicious code or links
|
||||||
- **Social Engineering**: Recognize and prevent social engineering attempts disguised as support requests
|
- **Social Engineering**: Recognise and prevent social engineering attempts disguised as support requests
|
||||||
- **Phishing Prevention**: Help community members identify and avoid phishing attempts
|
- **Phishing Prevention**: Help community members identify and avoid phishing attempts
|
||||||
|
|
||||||
**Technical Support Safety Protocols:**
|
**Technical Support Safety Protocols:**
|
||||||
@@ -439,7 +439,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Rollback Plans**: Help users understand how to reverse changes if needed
|
- **Rollback Plans**: Help users understand how to reverse changes if needed
|
||||||
- **Documentation Requirements**: Ensure critical changes are properly documented
|
- **Documentation Requirements**: Ensure critical changes are properly documented
|
||||||
|
|
||||||
#### 5.1.2 Community Safety Measures
|
#### 5.1.2. Community Safety Measures
|
||||||
|
|
||||||
**Protective Policies:**
|
**Protective Policies:**
|
||||||
- **Harassment Prevention**: Clear policies preventing exploitation of vulnerable community members
|
- **Harassment Prevention**: Clear policies preventing exploitation of vulnerable community members
|
||||||
@@ -448,9 +448,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Staff Oversight**: Regular staff monitoring and oversight of support interactions
|
- **Staff Oversight**: Regular staff monitoring and oversight of support interactions
|
||||||
- **Community Feedback**: Mechanisms for reporting concerning support interactions
|
- **Community Feedback**: Mechanisms for reporting concerning support interactions
|
||||||
|
|
||||||
### 5.2 Crisis Intervention and Professional Referral
|
### 5.2. Crisis Intervention and Professional Referral
|
||||||
|
|
||||||
#### 5.2.1 Crisis Recognition and Response
|
#### 5.2.1. Crisis Recognition and Response
|
||||||
|
|
||||||
**Crisis Identification:**
|
**Crisis Identification:**
|
||||||
- **Warning Signs**: Recognition of signs indicating professional intervention needs
|
- **Warning Signs**: Recognition of signs indicating professional intervention needs
|
||||||
@@ -466,7 +466,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Privacy Compliance**: Respect for privacy while ensuring safety
|
- **Privacy Compliance**: Respect for privacy while ensuring safety
|
||||||
- **Follow-Up Support**: Continued community support alongside professional services
|
- **Follow-Up Support**: Continued community support alongside professional services
|
||||||
|
|
||||||
#### 5.2.2 Legal and Ethical Obligations
|
#### 5.2.2. Legal and Ethical Obligations
|
||||||
|
|
||||||
**Mandatory Reporting:**
|
**Mandatory Reporting:**
|
||||||
- **Legal Requirements**: Compliance with local laws regarding mandatory reporting
|
- **Legal Requirements**: Compliance with local laws regarding mandatory reporting
|
||||||
@@ -484,9 +484,9 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
## 6. QUALITY ASSURANCE AND CONTINUOUS IMPROVEMENT
|
## 6. QUALITY ASSURANCE AND CONTINUOUS IMPROVEMENT
|
||||||
|
|
||||||
### 6.1 Support Quality Standards
|
### 6.1. Support Quality Standards
|
||||||
|
|
||||||
#### 6.1.1 Effective Support Characteristics
|
#### 6.1.1. Effective Support Characteristics
|
||||||
|
|
||||||
**Quality Indicators:**
|
**Quality Indicators:**
|
||||||
- **Respectful Interaction**: All support interactions demonstrate respect and dignity
|
- **Respectful Interaction**: All support interactions demonstrate respect and dignity
|
||||||
@@ -505,7 +505,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Continuous Improvement**: Ongoing improvement of support practices and resources
|
- **Continuous Improvement**: Ongoing improvement of support practices and resources
|
||||||
- **Training Updates**: Regular updates to support training and resources
|
- **Training Updates**: Regular updates to support training and resources
|
||||||
|
|
||||||
#### 6.1.2 Resource Maintenance and Updates
|
#### 6.1.2. Resource Maintenance and Updates
|
||||||
|
|
||||||
**Resource Quality Assurance:**
|
**Resource Quality Assurance:**
|
||||||
- **Regular Review**: Periodic review of shared resources for accuracy and relevance
|
- **Regular Review**: Periodic review of shared resources for accuracy and relevance
|
||||||
@@ -514,16 +514,16 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Accessibility Assessment**: Regular assessment of resource accessibility
|
- **Accessibility Assessment**: Regular assessment of resource accessibility
|
||||||
- **Cultural Appropriateness**: Ongoing evaluation of cultural appropriateness of resources
|
- **Cultural Appropriateness**: Ongoing evaluation of cultural appropriateness of resources
|
||||||
|
|
||||||
### 6.2 Community Learning and Development
|
### 6.2. Community Learning and Development
|
||||||
|
|
||||||
#### 6.2.1 Skill Building and Education
|
#### 6.2.1. Skill Building and Education
|
||||||
|
|
||||||
**Support Skills Development:**
|
**Support Skills Development:**
|
||||||
- **Peer Education**: Educational opportunities for improving support skills
|
- **Peer Education**: Educational opportunities for improving support skills
|
||||||
- **Cultural Competency**: Ongoing learning about cultural responsiveness
|
- **Cultural Competency**: Ongoing learning about cultural responsiveness
|
||||||
- **Trauma-Informed Approaches**: Education about trauma-informed support practices
|
- **Trauma-Informed Approaches**: Education about trauma-informed support practices
|
||||||
- **Boundary Management**: Training on maintaining healthy support boundaries
|
- **Boundary Management**: Training on maintaining healthy support boundaries
|
||||||
- **Crisis Recognition**: Education about recognizing crisis situations
|
- **Crisis Recognition**: Education about recognising crisis situations
|
||||||
- **Technical Competency**: Ongoing learning about products, APIs, and technical systems
|
- **Technical Competency**: Ongoing learning about products, APIs, and technical systems
|
||||||
- **Security Awareness**: Education about security best practices and threat recognition
|
- **Security Awareness**: Education about security best practices and threat recognition
|
||||||
- **Code Review Skills**: Training on effective and constructive code review practices
|
- **Code Review Skills**: Training on effective and constructive code review practices
|
||||||
@@ -535,7 +535,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
- **Skill Sharing**: Opportunities for community members to share relevant skills and knowledge
|
- **Skill Sharing**: Opportunities for community members to share relevant skills and knowledge
|
||||||
- **Professional Development**: Support for community members pursuing relevant professional development
|
- **Professional Development**: Support for community members pursuing relevant professional development
|
||||||
|
|
||||||
#### 6.2.2 Innovation and Improvement
|
#### 6.2.2. Innovation and Improvement
|
||||||
|
|
||||||
**Support System Evolution:**
|
**Support System Evolution:**
|
||||||
- **New Approach Development**: Innovation in peer support approaches and methods
|
- **New Approach Development**: Innovation in peer support approaches and methods
|
||||||
@@ -546,7 +546,7 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
**Partnership and Collaboration:**
|
**Partnership and Collaboration:**
|
||||||
- **Professional Service Partnerships**: Appropriate partnerships with professional service providers
|
- **Professional Service Partnerships**: Appropriate partnerships with professional service providers
|
||||||
- **Community Organization Collaboration**: Collaboration with other community organizations
|
- **Community Organization Collaboration**: Collaboration with other community organisations
|
||||||
- **Resource Sharing Networks**: Participation in resource sharing networks
|
- **Resource Sharing Networks**: Participation in resource sharing networks
|
||||||
- **Best Practice Communities**: Participation in communities focused on peer support best practices
|
- **Best Practice Communities**: Participation in communities focused on peer support best practices
|
||||||
- **Research Participation**: Appropriate participation in research on effective community support
|
- **Research Participation**: Appropriate participation in research on effective community support
|
||||||
@@ -555,6 +555,3 @@ This policy applies to all forms of support exchange within our community platfo
|
|||||||
|
|
||||||
*This Community Support Policy is designed to create a safe, supportive, and sustainable framework for mutual aid within our community. This policy works in conjunction with our Crisis and Mental Health Management Policy, Community Code of Conduct, and staff training materials to ensure comprehensive community support. For questions about this policy or to report concerns about support interactions, please contact community staff through established channels.*
|
*This Community Support Policy is designed to create a safe, supportive, and sustainable framework for mutual aid within our community. This policy works in conjunction with our Crisis and Mental Health Management Policy, Community Code of Conduct, and staff training materials to ensure comprehensive community support. For questions about this policy or to report concerns about support interactions, please contact community staff through established channels.*
|
||||||
|
|
||||||
**Document Version**: 1.0
|
|
||||||
**Last Updated**: 25 September 2025
|
|
||||||
**Next Review Date**: 25 March 2026
|
|
||||||
@@ -6,11 +6,11 @@ title: Content and Moderation Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Purpose and Objectives
|
### 1.1. Policy Purpose and Objectives
|
||||||
|
|
||||||
This Content and Moderation Policy ("Policy") establishes comprehensive standards for content creation, sharing, and moderation across all services, platforms, and applications operated by nhcarrigan ("we," "us," "our," or "the Company"). This Policy aims to maintain safe, inclusive, and productive environments whilst balancing free expression with community safety and legal compliance.
|
This Content and Moderation Policy ("Policy") establishes comprehensive standards for content creation, sharing, and moderation across all services, platforms, and applications operated by NHCarrigan ("we," "us," "our," or "the Company"). This Policy aims to maintain safe, inclusive, and productive environments whilst balancing free expression with community safety and legal compliance.
|
||||||
|
|
||||||
### 1.2 Scope of Application
|
### 1.2. Scope of Application
|
||||||
|
|
||||||
This Policy applies to all content and user interactions across:
|
This Policy applies to all content and user interactions across:
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ This Policy applies to all content and user interactions across:
|
|||||||
|
|
||||||
**(h)** Any other platforms or services that facilitate user content or communication.
|
**(h)** Any other platforms or services that facilitate user content or communication.
|
||||||
|
|
||||||
### 1.3 Integration with Other Policies
|
### 1.3. Integration with Other Policies
|
||||||
|
|
||||||
This Policy operates in conjunction with our comprehensive policy framework:
|
This Policy operates in conjunction with our comprehensive policy framework:
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ This Policy operates in conjunction with our comprehensive policy framework:
|
|||||||
|
|
||||||
**(j)** Platform-specific community guidelines and rules where applicable.
|
**(j)** Platform-specific community guidelines and rules where applicable.
|
||||||
|
|
||||||
### 1.4 Definitions and Terminology
|
### 1.4. Definitions and Terminology
|
||||||
|
|
||||||
For the purposes of this Policy:
|
For the purposes of this Policy:
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ For the purposes of this Policy:
|
|||||||
|
|
||||||
## 2. CONTENT STANDARDS AND GUIDELINES
|
## 2. CONTENT STANDARDS AND GUIDELINES
|
||||||
|
|
||||||
### 2.1 Acceptable Content Principles
|
### 2.1. Acceptable Content Principles
|
||||||
|
|
||||||
All content on our platforms must adhere to the following principles:
|
All content on our platforms must adhere to the following principles:
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ All content on our platforms must adhere to the following principles:
|
|||||||
|
|
||||||
**(h)** **Community Benefit**: Content should benefit the broader community and support our platform objectives.
|
**(h)** **Community Benefit**: Content should benefit the broader community and support our platform objectives.
|
||||||
|
|
||||||
### 2.2 Encouraged Content Types
|
### 2.2. Encouraged Content Types
|
||||||
|
|
||||||
We particularly welcome and encourage:
|
We particularly welcome and encourage:
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ We particularly welcome and encourage:
|
|||||||
|
|
||||||
**(h)** **Well-Documented**: Content that provides clear documentation, examples, and references.
|
**(h)** **Well-Documented**: Content that provides clear documentation, examples, and references.
|
||||||
|
|
||||||
### 2.3 Content Quality Standards
|
### 2.3. Content Quality Standards
|
||||||
|
|
||||||
Quality content on our platforms should demonstrate:
|
Quality content on our platforms should demonstrate:
|
||||||
|
|
||||||
@@ -132,7 +132,7 @@ Quality content on our platforms should demonstrate:
|
|||||||
|
|
||||||
**(h)** **Accessible Format**: Content formatted for accessibility and ease of consumption.
|
**(h)** **Accessible Format**: Content formatted for accessibility and ease of consumption.
|
||||||
|
|
||||||
### 2.4 Platform-Specific Guidelines
|
### 2.4. Platform-Specific Guidelines
|
||||||
|
|
||||||
Different platforms may have additional specific guidelines:
|
Different platforms may have additional specific guidelines:
|
||||||
|
|
||||||
@@ -154,7 +154,7 @@ Different platforms may have additional specific guidelines:
|
|||||||
|
|
||||||
## 3. PROHIBITED CONTENT CATEGORIES
|
## 3. PROHIBITED CONTENT CATEGORIES
|
||||||
|
|
||||||
### 3.1 Illegal and Harmful Content
|
### 3.1. Illegal and Harmful Content
|
||||||
|
|
||||||
The following types of content are strictly prohibited:
|
The following types of content are strictly prohibited:
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ The following types of content are strictly prohibited:
|
|||||||
|
|
||||||
**(h)** **Human Trafficking**: Content related to human trafficking or modern slavery.
|
**(h)** **Human Trafficking**: Content related to human trafficking or modern slavery.
|
||||||
|
|
||||||
### 3.2 Inappropriate and Offensive Content
|
### 3.2. Inappropriate and Offensive Content
|
||||||
|
|
||||||
Content that violates community standards includes:
|
Content that violates community standards includes:
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ Content that violates community standards includes:
|
|||||||
|
|
||||||
**(h)** **Degrading Content**: Content that degrades or dehumanises individuals or groups.
|
**(h)** **Degrading Content**: Content that degrades or dehumanises individuals or groups.
|
||||||
|
|
||||||
### 3.3 Spam and Low-Quality Content
|
### 3.3. Spam and Low-Quality Content
|
||||||
|
|
||||||
Prohibited spam and low-quality content includes:
|
Prohibited spam and low-quality content includes:
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ Prohibited spam and low-quality content includes:
|
|||||||
|
|
||||||
**(h)** **Bot-Generated Content**: Automated content that doesn't add value to discussions.
|
**(h)** **Bot-Generated Content**: Automated content that doesn't add value to discussions.
|
||||||
|
|
||||||
### 3.4 Intellectual Property Violations
|
### 3.4. Intellectual Property Violations
|
||||||
|
|
||||||
Content that violates intellectual property rights includes:
|
Content that violates intellectual property rights includes:
|
||||||
|
|
||||||
@@ -234,7 +234,7 @@ Content that violates intellectual property rights includes:
|
|||||||
|
|
||||||
**(h)** **False Attribution**: Misrepresenting the ownership or source of intellectual property.
|
**(h)** **False Attribution**: Misrepresenting the ownership or source of intellectual property.
|
||||||
|
|
||||||
### 3.5 Misinformation and Deceptive Content
|
### 3.5. Misinformation and Deceptive Content
|
||||||
|
|
||||||
Prohibited misinformation and deceptive practices include:
|
Prohibited misinformation and deceptive practices include:
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ Prohibited misinformation and deceptive practices include:
|
|||||||
|
|
||||||
## 4. MODERATION APPROACH AND METHODOLOGY
|
## 4. MODERATION APPROACH AND METHODOLOGY
|
||||||
|
|
||||||
### 4.1 Multi-Layered Moderation System
|
### 4.1. Multi-Layered Moderation System
|
||||||
|
|
||||||
Our moderation approach employs multiple layers:
|
Our moderation approach employs multiple layers:
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ Our moderation approach employs multiple layers:
|
|||||||
|
|
||||||
**(h)** **Quality Assurance**: Quality assurance processes for moderation consistency and accuracy.
|
**(h)** **Quality Assurance**: Quality assurance processes for moderation consistency and accuracy.
|
||||||
|
|
||||||
### 4.2 Proactive and Reactive Moderation
|
### 4.2. Proactive and Reactive Moderation
|
||||||
|
|
||||||
We employ both proactive and reactive moderation strategies:
|
We employ both proactive and reactive moderation strategies:
|
||||||
|
|
||||||
@@ -300,7 +300,7 @@ We employ both proactive and reactive moderation strategies:
|
|||||||
|
|
||||||
**(d)** **Incident Response**: Response to significant content-related incidents.
|
**(d)** **Incident Response**: Response to significant content-related incidents.
|
||||||
|
|
||||||
### 4.3 Context-Sensitive Moderation
|
### 4.3. Context-Sensitive Moderation
|
||||||
|
|
||||||
Our moderation decisions consider:
|
Our moderation decisions consider:
|
||||||
|
|
||||||
@@ -320,7 +320,7 @@ Our moderation decisions consider:
|
|||||||
|
|
||||||
**(h)** **Legal Requirements**: Compliance with applicable legal requirements in different jurisdictions.
|
**(h)** **Legal Requirements**: Compliance with applicable legal requirements in different jurisdictions.
|
||||||
|
|
||||||
### 4.4 Moderation Decision Framework
|
### 4.4. Moderation Decision Framework
|
||||||
|
|
||||||
Moderation decisions follow a structured framework:
|
Moderation decisions follow a structured framework:
|
||||||
|
|
||||||
@@ -342,7 +342,7 @@ Moderation decisions follow a structured framework:
|
|||||||
|
|
||||||
## 5. ENFORCEMENT ACTIONS AND CONSEQUENCES
|
## 5. ENFORCEMENT ACTIONS AND CONSEQUENCES
|
||||||
|
|
||||||
### 5.1 Range of Enforcement Actions
|
### 5.1. Range of Enforcement Actions
|
||||||
|
|
||||||
We may take the following enforcement actions for policy violations:
|
We may take the following enforcement actions for policy violations:
|
||||||
|
|
||||||
@@ -362,7 +362,7 @@ We may take the following enforcement actions for policy violations:
|
|||||||
|
|
||||||
**(h)** **Account Termination**: Permanently terminating user accounts for serious or repeated violations.
|
**(h)** **Account Termination**: Permanently terminating user accounts for serious or repeated violations.
|
||||||
|
|
||||||
### 5.2 Progressive Enforcement Approach
|
### 5.2. Progressive Enforcement Approach
|
||||||
|
|
||||||
Our enforcement generally follows a progressive approach:
|
Our enforcement generally follows a progressive approach:
|
||||||
|
|
||||||
@@ -386,7 +386,7 @@ Our enforcement generally follows a progressive approach:
|
|||||||
**(b)** Removal from community platforms;
|
**(b)** Removal from community platforms;
|
||||||
**(c)** Potential legal action for serious violations.
|
**(c)** Potential legal action for serious violations.
|
||||||
|
|
||||||
### 5.3 Immediate Action Circumstances
|
### 5.3. Immediate Action Circumstances
|
||||||
|
|
||||||
Immediate severe enforcement may be applied for:
|
Immediate severe enforcement may be applied for:
|
||||||
|
|
||||||
@@ -406,7 +406,7 @@ Immediate severe enforcement may be applied for:
|
|||||||
|
|
||||||
**(h)** **Terms of Service Violations**: Serious violations of fundamental terms of service.
|
**(h)** **Terms of Service Violations**: Serious violations of fundamental terms of service.
|
||||||
|
|
||||||
### 5.4 Account Status and Restrictions
|
### 5.4. Account Status and Restrictions
|
||||||
|
|
||||||
Account restrictions may include:
|
Account restrictions may include:
|
||||||
|
|
||||||
@@ -428,7 +428,7 @@ Account restrictions may include:
|
|||||||
|
|
||||||
## 6. COMMUNITY REPORTING AND PARTICIPATION
|
## 6. COMMUNITY REPORTING AND PARTICIPATION
|
||||||
|
|
||||||
### 6.1 Community Reporting Mechanisms
|
### 6.1. Community Reporting Mechanisms
|
||||||
|
|
||||||
We provide multiple ways for community members to report problematic content:
|
We provide multiple ways for community members to report problematic content:
|
||||||
|
|
||||||
@@ -448,7 +448,7 @@ We provide multiple ways for community members to report problematic content:
|
|||||||
|
|
||||||
**(h)** **Batch Reporting**: Mechanisms for reporting multiple related violations efficiently.
|
**(h)** **Batch Reporting**: Mechanisms for reporting multiple related violations efficiently.
|
||||||
|
|
||||||
### 6.2 What to Include in Reports
|
### 6.2. What to Include in Reports
|
||||||
|
|
||||||
Effective reports should include:
|
Effective reports should include:
|
||||||
|
|
||||||
@@ -468,7 +468,7 @@ Effective reports should include:
|
|||||||
|
|
||||||
**(h)** **Contact Information**: Your contact information for follow-up questions (where desired).
|
**(h)** **Contact Information**: Your contact information for follow-up questions (where desired).
|
||||||
|
|
||||||
### 6.3 Community Moderation Programme
|
### 6.3. Community Moderation Programme
|
||||||
|
|
||||||
We may establish community moderation programmes that include:
|
We may establish community moderation programmes that include:
|
||||||
|
|
||||||
@@ -488,7 +488,7 @@ We may establish community moderation programmes that include:
|
|||||||
|
|
||||||
**(h)** **Feedback Mechanisms**: Regular feedback and improvement processes for community moderation.
|
**(h)** **Feedback Mechanisms**: Regular feedback and improvement processes for community moderation.
|
||||||
|
|
||||||
### 6.4 Reporter Protection and Support
|
### 6.4. Reporter Protection and Support
|
||||||
|
|
||||||
We are committed to protecting community members who report violations:
|
We are committed to protecting community members who report violations:
|
||||||
|
|
||||||
@@ -510,7 +510,7 @@ We are committed to protecting community members who report violations:
|
|||||||
|
|
||||||
## 7. APPEALS AND REVIEW PROCESS
|
## 7. APPEALS AND REVIEW PROCESS
|
||||||
|
|
||||||
### 7.1 Right to Appeal
|
### 7.1. Right to Appeal
|
||||||
|
|
||||||
Users have the right to appeal moderation decisions including:
|
Users have the right to appeal moderation decisions including:
|
||||||
|
|
||||||
@@ -530,7 +530,7 @@ Users have the right to appeal moderation decisions including:
|
|||||||
|
|
||||||
**(h)** **Policy Interpretations**: Appeals regarding interpretation of policy provisions.
|
**(h)** **Policy Interpretations**: Appeals regarding interpretation of policy provisions.
|
||||||
|
|
||||||
### 7.2 Appeals Process
|
### 7.2. Appeals Process
|
||||||
|
|
||||||
The appeals process includes the following steps:
|
The appeals process includes the following steps:
|
||||||
|
|
||||||
@@ -550,7 +550,7 @@ The appeals process includes the following steps:
|
|||||||
|
|
||||||
**(h)** **Follow-up**: Follow-up to ensure proper implementation and user satisfaction.
|
**(h)** **Follow-up**: Follow-up to ensure proper implementation and user satisfaction.
|
||||||
|
|
||||||
### 7.3 Appeal Requirements and Information
|
### 7.3. Appeal Requirements and Information
|
||||||
|
|
||||||
Effective appeals should include:
|
Effective appeals should include:
|
||||||
|
|
||||||
@@ -570,7 +570,7 @@ Effective appeals should include:
|
|||||||
|
|
||||||
**(h)** **Supporting Documentation**: Any supporting documentation, screenshots, or references.
|
**(h)** **Supporting Documentation**: Any supporting documentation, screenshots, or references.
|
||||||
|
|
||||||
### 7.4 Appeal Outcomes and Implementation
|
### 7.4. Appeal Outcomes and Implementation
|
||||||
|
|
||||||
Appeal decisions may result in:
|
Appeal decisions may result in:
|
||||||
|
|
||||||
@@ -592,7 +592,7 @@ Appeal decisions may result in:
|
|||||||
|
|
||||||
## 8. TRANSPARENCY AND ACCOUNTABILITY
|
## 8. TRANSPARENCY AND ACCOUNTABILITY
|
||||||
|
|
||||||
### 8.1 Transparency Reporting
|
### 8.1. Transparency Reporting
|
||||||
|
|
||||||
We are committed to transparency in our moderation practices through:
|
We are committed to transparency in our moderation practices through:
|
||||||
|
|
||||||
@@ -612,7 +612,7 @@ We are committed to transparency in our moderation practices through:
|
|||||||
|
|
||||||
**(h)** **Community Feedback**: Reports on community feedback and input on moderation practices.
|
**(h)** **Community Feedback**: Reports on community feedback and input on moderation practices.
|
||||||
|
|
||||||
### 8.2 Accountability Mechanisms
|
### 8.2. Accountability Mechanisms
|
||||||
|
|
||||||
We maintain accountability through:
|
We maintain accountability through:
|
||||||
|
|
||||||
@@ -632,7 +632,7 @@ We maintain accountability through:
|
|||||||
|
|
||||||
**(h)** **Stakeholder Engagement**: Engagement with community stakeholders on moderation practices.
|
**(h)** **Stakeholder Engagement**: Engagement with community stakeholders on moderation practices.
|
||||||
|
|
||||||
### 8.3 Community Input and Participation
|
### 8.3. Community Input and Participation
|
||||||
|
|
||||||
We seek community input through:
|
We seek community input through:
|
||||||
|
|
||||||
@@ -652,7 +652,7 @@ We seek community input through:
|
|||||||
|
|
||||||
**(h)** **Co-Creation Processes**: Collaborative development of community standards and guidelines.
|
**(h)** **Co-Creation Processes**: Collaborative development of community standards and guidelines.
|
||||||
|
|
||||||
### 8.4 External Accountability
|
### 8.4. External Accountability
|
||||||
|
|
||||||
We engage in external accountability through:
|
We engage in external accountability through:
|
||||||
|
|
||||||
@@ -674,7 +674,7 @@ We engage in external accountability through:
|
|||||||
|
|
||||||
## 9. SPECIAL CONSIDERATIONS AND CONTEXTS
|
## 9. SPECIAL CONSIDERATIONS AND CONTEXTS
|
||||||
|
|
||||||
### 9.1 Cultural and Regional Sensitivity
|
### 9.1. Cultural and Regional Sensitivity
|
||||||
|
|
||||||
Our moderation practices consider:
|
Our moderation practices consider:
|
||||||
|
|
||||||
@@ -694,7 +694,7 @@ Our moderation practices consider:
|
|||||||
|
|
||||||
**(h)** **Inclusive Practices**: Promotion of inclusive practices that welcome diverse perspectives.
|
**(h)** **Inclusive Practices**: Promotion of inclusive practices that welcome diverse perspectives.
|
||||||
|
|
||||||
### 9.2 Vulnerable Populations
|
### 9.2. Vulnerable Populations
|
||||||
|
|
||||||
We provide enhanced protections for:
|
We provide enhanced protections for:
|
||||||
|
|
||||||
@@ -714,7 +714,7 @@ We provide enhanced protections for:
|
|||||||
|
|
||||||
**(h)** **Digital Literacy**: Support for users with varying levels of digital literacy.
|
**(h)** **Digital Literacy**: Support for users with varying levels of digital literacy.
|
||||||
|
|
||||||
### 9.3 Crisis and Emergency Response
|
### 9.3. Crisis and Emergency Response
|
||||||
|
|
||||||
During crises or emergencies, we may:
|
During crises or emergencies, we may:
|
||||||
|
|
||||||
@@ -734,7 +734,7 @@ During crises or emergencies, we may:
|
|||||||
|
|
||||||
**(h)** **Post-Crisis Review**: Conduct post-crisis reviews to improve future emergency responses.
|
**(h)** **Post-Crisis Review**: Conduct post-crisis reviews to improve future emergency responses.
|
||||||
|
|
||||||
### 9.4 Emerging Technologies and Trends
|
### 9.4. Emerging Technologies and Trends
|
||||||
|
|
||||||
We adapt our moderation practices to address:
|
We adapt our moderation practices to address:
|
||||||
|
|
||||||
@@ -756,7 +756,7 @@ We adapt our moderation practices to address:
|
|||||||
|
|
||||||
## 10. TRAINING AND DEVELOPMENT
|
## 10. TRAINING AND DEVELOPMENT
|
||||||
|
|
||||||
### 10.1 Moderator Training Programmes
|
### 10.1. Moderator Training Programmes
|
||||||
|
|
||||||
Our moderation training includes:
|
Our moderation training includes:
|
||||||
|
|
||||||
@@ -776,7 +776,7 @@ Our moderation training includes:
|
|||||||
|
|
||||||
**(h)** **Continuous Education**: Ongoing education and professional development opportunities.
|
**(h)** **Continuous Education**: Ongoing education and professional development opportunities.
|
||||||
|
|
||||||
### 10.2 Quality Assurance and Consistency
|
### 10.2. Quality Assurance and Consistency
|
||||||
|
|
||||||
We maintain quality through:
|
We maintain quality through:
|
||||||
|
|
||||||
@@ -796,7 +796,7 @@ We maintain quality through:
|
|||||||
|
|
||||||
**(h)** **Improvement Planning**: Systematic planning for continuous improvement in moderation quality.
|
**(h)** **Improvement Planning**: Systematic planning for continuous improvement in moderation quality.
|
||||||
|
|
||||||
### 10.3 Technology and Tools Training
|
### 10.3. Technology and Tools Training
|
||||||
|
|
||||||
Training on moderation technology includes:
|
Training on moderation technology includes:
|
||||||
|
|
||||||
@@ -816,7 +816,7 @@ Training on moderation technology includes:
|
|||||||
|
|
||||||
**(h)** **Integration Tools**: Understanding integration between different moderation tools and platforms.
|
**(h)** **Integration Tools**: Understanding integration between different moderation tools and platforms.
|
||||||
|
|
||||||
### 10.4 Wellbeing and Support
|
### 10.4. Wellbeing and Support
|
||||||
|
|
||||||
We provide support for moderation staff including:
|
We provide support for moderation staff including:
|
||||||
|
|
||||||
@@ -838,7 +838,7 @@ We provide support for moderation staff including:
|
|||||||
|
|
||||||
## 11. POLICY EVOLUTION AND UPDATES
|
## 11. POLICY EVOLUTION AND UPDATES
|
||||||
|
|
||||||
### 11.1 Continuous Policy Development
|
### 11.1. Continuous Policy Development
|
||||||
|
|
||||||
Our content policies evolve through:
|
Our content policies evolve through:
|
||||||
|
|
||||||
@@ -858,7 +858,7 @@ Our content policies evolve through:
|
|||||||
|
|
||||||
**(h)** **Social Evolution**: Response to changing social norms and expectations.
|
**(h)** **Social Evolution**: Response to changing social norms and expectations.
|
||||||
|
|
||||||
### 11.2 Policy Update Process
|
### 11.2. Policy Update Process
|
||||||
|
|
||||||
Policy updates follow a structured process:
|
Policy updates follow a structured process:
|
||||||
|
|
||||||
@@ -878,7 +878,7 @@ Policy updates follow a structured process:
|
|||||||
|
|
||||||
**(h)** **Monitoring and Evaluation**: Ongoing monitoring and evaluation of policy effectiveness.
|
**(h)** **Monitoring and Evaluation**: Ongoing monitoring and evaluation of policy effectiveness.
|
||||||
|
|
||||||
### 11.3 Communication of Changes
|
### 11.3. Communication of Changes
|
||||||
|
|
||||||
Policy changes are communicated through:
|
Policy changes are communicated through:
|
||||||
|
|
||||||
@@ -898,7 +898,7 @@ Policy changes are communicated through:
|
|||||||
|
|
||||||
**(h)** **Feedback Channels**: Channels for feedback on policy changes and implementation.
|
**(h)** **Feedback Channels**: Channels for feedback on policy changes and implementation.
|
||||||
|
|
||||||
### 11.4 Emergency Policy Updates
|
### 11.4. Emergency Policy Updates
|
||||||
|
|
||||||
In emergency situations, we may:
|
In emergency situations, we may:
|
||||||
|
|
||||||
@@ -920,7 +920,7 @@ In emergency situations, we may:
|
|||||||
|
|
||||||
## 12. CONTACT INFORMATION AND SUPPORT
|
## 12. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 12.1 Content Policy Questions
|
### 12.1. Content Policy Questions
|
||||||
|
|
||||||
For questions about our content policies:
|
For questions about our content policies:
|
||||||
|
|
||||||
@@ -930,7 +930,7 @@ For questions about our content policies:
|
|||||||
|
|
||||||
**Response Time:** Within 3 business days for policy clarification requests
|
**Response Time:** Within 3 business days for policy clarification requests
|
||||||
|
|
||||||
### 12.2 Content Reporting
|
### 12.2. Content Reporting
|
||||||
|
|
||||||
To report problematic content:
|
To report problematic content:
|
||||||
|
|
||||||
@@ -942,7 +942,7 @@ To report problematic content:
|
|||||||
|
|
||||||
**Response Time:** Within 24 hours for urgent reports, 48 hours for standard reports
|
**Response Time:** Within 24 hours for urgent reports, 48 hours for standard reports
|
||||||
|
|
||||||
### 12.3 Moderation Appeals
|
### 12.3. Moderation Appeals
|
||||||
|
|
||||||
For appeals of moderation decisions:
|
For appeals of moderation decisions:
|
||||||
|
|
||||||
@@ -954,26 +954,18 @@ For appeals of moderation decisions:
|
|||||||
|
|
||||||
**Response Time:** Within 5 business days for appeal reviews
|
**Response Time:** Within 5 business days for appeal reviews
|
||||||
|
|
||||||
### 12.4 Community Support
|
### 12.4. Community Support
|
||||||
|
|
||||||
For general community support and guidance:
|
For general community support and guidance:
|
||||||
|
|
||||||
**Email:** community@nhcarrigan.com
|
**Email:** community@nhcarrigan.com
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com/community-support
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Response Time:** Within 48 hours for community support requests
|
**Response Time:** Within 48 hours for community support requests
|
||||||
|
|
||||||
**Live Chat:** Available during business hours for immediate assistance
|
**Live Chat:** Available during business hours for immediate assistance
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 March 2026
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Content and Moderation Policy establishes our commitment to maintaining safe, inclusive, and productive communities. By participating in our platforms, you agree to abide by these content standards and acknowledge our moderation practices. For questions about content policies or to report violations, please contact us at moderation@nhcarrigan.com.*
|
*This Content and Moderation Policy establishes our commitment to maintaining safe, inclusive, and productive communities. By participating in our platforms, you agree to abide by these content standards and acknowledge our moderation practices. For questions about content policies or to report violations, please contact us at moderation@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Crisis and Mental Health Management Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Purpose and Objectives
|
### 1.1. Policy Purpose and Objectives
|
||||||
|
|
||||||
This Crisis and Mental Health Management Policy ("Policy") establishes comprehensive protocols for identifying, responding to, and managing mental health crises and related situations across all services, platforms, and applications operated by nhcarrigan ("we," "us," "our," or "the Company"). This Policy aims to provide appropriate support whilst maintaining clear boundaries regarding our capabilities and legal obligations.
|
This Crisis and Mental Health Management Policy ("Policy") establishes comprehensive protocols for identifying, responding to, and managing mental health crises and related situations across all services, platforms, and applications operated by NHCarrigan ("we," "us," "our," or "the Company"). This Policy aims to provide appropriate support whilst maintaining clear boundaries regarding our capabilities and legal obligations.
|
||||||
|
|
||||||
### 1.2 Important Disclaimers and Limitations
|
### 1.2. Important Disclaimers and Limitations
|
||||||
|
|
||||||
**CRITICAL NOTICE:**
|
**CRITICAL NOTICE:**
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ This Crisis and Mental Health Management Policy ("Policy") establishes comprehen
|
|||||||
|
|
||||||
**(e)** Our responses are limited to basic support, resource provision, and appropriate referrals.
|
**(e)** Our responses are limited to basic support, resource provision, and appropriate referrals.
|
||||||
|
|
||||||
### 1.3 Scope of Application
|
### 1.3. Scope of Application
|
||||||
|
|
||||||
This Policy applies to:
|
This Policy applies to:
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ This Policy applies to:
|
|||||||
|
|
||||||
**(f)** Emergency reporting obligations and legal compliance requirements.
|
**(f)** Emergency reporting obligations and legal compliance requirements.
|
||||||
|
|
||||||
### 1.4 Integration with Other Policies
|
### 1.4. Integration with Other Policies
|
||||||
|
|
||||||
This Policy operates in conjunction with:
|
This Policy operates in conjunction with:
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ This Policy operates in conjunction with:
|
|||||||
|
|
||||||
## 2. RECOGNITION AND IDENTIFICATION
|
## 2. RECOGNITION AND IDENTIFICATION
|
||||||
|
|
||||||
### 2.1 Crisis Indicators
|
### 2.1. Crisis Indicators
|
||||||
|
|
||||||
We train our team to recognise potential mental health crisis indicators including:
|
We train our team to recognise potential mental health crisis indicators including:
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ We train our team to recognise potential mental health crisis indicators includi
|
|||||||
|
|
||||||
**(h)** **Sudden Behavioural Changes:** Dramatic changes in communication patterns or behaviour.
|
**(h)** **Sudden Behavioural Changes:** Dramatic changes in communication patterns or behaviour.
|
||||||
|
|
||||||
### 2.2 Risk Assessment Levels
|
### 2.2. Risk Assessment Levels
|
||||||
|
|
||||||
We categorise potential situations into three risk levels:
|
We categorise potential situations into three risk levels:
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ We categorise potential situations into three risk levels:
|
|||||||
**(c)** Discussions about mental health challenges without crisis indicators;
|
**(c)** Discussions about mental health challenges without crisis indicators;
|
||||||
**(d)** Seeking community support for mental health issues.
|
**(d)** Seeking community support for mental health issues.
|
||||||
|
|
||||||
### 2.3 False Positives and Context Consideration
|
### 2.3. False Positives and Context Consideration
|
||||||
|
|
||||||
Our team is trained to consider:
|
Our team is trained to consider:
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ Our team is trained to consider:
|
|||||||
|
|
||||||
## 3. IMMEDIATE RESPONSE PROTOCOLS
|
## 3. IMMEDIATE RESPONSE PROTOCOLS
|
||||||
|
|
||||||
### 3.1 High-Risk Situation Response
|
### 3.1. High-Risk Situation Response
|
||||||
|
|
||||||
For HIGH RISK situations involving imminent danger:
|
For HIGH RISK situations involving imminent danger:
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ For HIGH RISK situations involving imminent danger:
|
|||||||
|
|
||||||
**(h)** **Maintain Confidentiality:** Limit information sharing to essential personnel only.
|
**(h)** **Maintain Confidentiality:** Limit information sharing to essential personnel only.
|
||||||
|
|
||||||
### 3.2 Medium-Risk Situation Response
|
### 3.2. Medium-Risk Situation Response
|
||||||
|
|
||||||
For MEDIUM RISK situations involving concerning behaviour:
|
For MEDIUM RISK situations involving concerning behaviour:
|
||||||
|
|
||||||
@@ -166,7 +166,7 @@ For MEDIUM RISK situations involving concerning behaviour:
|
|||||||
|
|
||||||
**(h)** **Monitor for Escalation:** Watch for signs of increasing risk level.
|
**(h)** **Monitor for Escalation:** Watch for signs of increasing risk level.
|
||||||
|
|
||||||
### 3.3 Low-Risk Situation Response
|
### 3.3. Low-Risk Situation Response
|
||||||
|
|
||||||
For LOW RISK situations involving general mental health concerns:
|
For LOW RISK situations involving general mental health concerns:
|
||||||
|
|
||||||
@@ -188,7 +188,7 @@ For LOW RISK situations involving general mental health concerns:
|
|||||||
|
|
||||||
**(h)** **Available Support:** Make clear what ongoing support we can and cannot provide.
|
**(h)** **Available Support:** Make clear what ongoing support we can and cannot provide.
|
||||||
|
|
||||||
### 3.4 Response Templates and Guidelines
|
### 3.4. Response Templates and Guidelines
|
||||||
|
|
||||||
**APPROPRIATE RESPONSES:**
|
**APPROPRIATE RESPONSES:**
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ For LOW RISK situations involving general mental health concerns:
|
|||||||
|
|
||||||
## 4. EMERGENCY REPORTING AND LEGAL OBLIGATIONS
|
## 4. EMERGENCY REPORTING AND LEGAL OBLIGATIONS
|
||||||
|
|
||||||
### 4.1 Mandatory Reporting Requirements
|
### 4.1. Mandatory Reporting Requirements
|
||||||
|
|
||||||
We are legally obligated to report to appropriate authorities when:
|
We are legally obligated to report to appropriate authorities when:
|
||||||
|
|
||||||
@@ -240,7 +240,7 @@ We are legally obligated to report to appropriate authorities when:
|
|||||||
|
|
||||||
**(h)** **Emergency Circumstances:** When emergency services intervention may be necessary.
|
**(h)** **Emergency Circumstances:** When emergency services intervention may be necessary.
|
||||||
|
|
||||||
### 4.2 Information Sharing Protocols
|
### 4.2. Information Sharing Protocols
|
||||||
|
|
||||||
When reporting is necessary:
|
When reporting is necessary:
|
||||||
|
|
||||||
@@ -260,7 +260,7 @@ When reporting is necessary:
|
|||||||
|
|
||||||
**(h)** **Professional Standards:** Follow all applicable professional and legal standards.
|
**(h)** **Professional Standards:** Follow all applicable professional and legal standards.
|
||||||
|
|
||||||
### 4.3 Jurisdictional Considerations
|
### 4.3. Jurisdictional Considerations
|
||||||
|
|
||||||
Our reporting obligations vary by jurisdiction and may include:
|
Our reporting obligations vary by jurisdiction and may include:
|
||||||
|
|
||||||
@@ -280,7 +280,7 @@ Our reporting obligations vary by jurisdiction and may include:
|
|||||||
|
|
||||||
**(h)** **Treaty Obligations:** International agreements on emergency assistance.
|
**(h)** **Treaty Obligations:** International agreements on emergency assistance.
|
||||||
|
|
||||||
### 4.4 Emergency Contact Protocols
|
### 4.4. Emergency Contact Protocols
|
||||||
|
|
||||||
For immediate emergencies, we maintain:
|
For immediate emergencies, we maintain:
|
||||||
|
|
||||||
@@ -302,7 +302,7 @@ For immediate emergencies, we maintain:
|
|||||||
|
|
||||||
## 5. RESOURCES AND REFERRALS
|
## 5. RESOURCES AND REFERRALS
|
||||||
|
|
||||||
### 5.1 Crisis Resources Database
|
### 5.1. Crisis Resources Database
|
||||||
|
|
||||||
We maintain an up-to-date database of:
|
We maintain an up-to-date database of:
|
||||||
|
|
||||||
@@ -322,7 +322,7 @@ We maintain an up-to-date database of:
|
|||||||
|
|
||||||
**(g)** **Emergency Services:** 911 (US), 999 (UK), 112 (EU), 000 (Australia);
|
**(g)** **Emergency Services:** 911 (US), 999 (UK), 112 (EU), 000 (Australia);
|
||||||
|
|
||||||
**(h)** **Local Crisis Centers:** Regional crisis intervention centres.
|
**(h)** **Local Crisis Centres:** Regional crisis intervention centres.
|
||||||
|
|
||||||
**ONGOING SUPPORT RESOURCES:**
|
**ONGOING SUPPORT RESOURCES:**
|
||||||
|
|
||||||
@@ -336,13 +336,13 @@ We maintain an up-to-date database of:
|
|||||||
|
|
||||||
**(e)** **Peer Support Networks:** Peer-led mental health support groups;
|
**(e)** **Peer Support Networks:** Peer-led mental health support groups;
|
||||||
|
|
||||||
**(f)** **Community Mental Health Centers:** Local community-based services;
|
**(f)** **Community Mental Health Centres:** Local community-based services;
|
||||||
|
|
||||||
**(g)** **University Counselling Centers:** For students and academic community;
|
**(g)** **University Counselling Centres:** For students and academic community;
|
||||||
|
|
||||||
**(h)** **Employee Assistance Programs:** Workplace mental health resources.
|
**(h)** **Employee Assistance Programs:** Workplace mental health resources.
|
||||||
|
|
||||||
### 5.2 Specialised Resources
|
### 5.2. Specialised Resources
|
||||||
|
|
||||||
**DEMOGRAPHIC-SPECIFIC RESOURCES:**
|
**DEMOGRAPHIC-SPECIFIC RESOURCES:**
|
||||||
|
|
||||||
@@ -362,7 +362,7 @@ We maintain an up-to-date database of:
|
|||||||
|
|
||||||
**(h)** **Accessibility Resources:** Services for individuals with disabilities.
|
**(h)** **Accessibility Resources:** Services for individuals with disabilities.
|
||||||
|
|
||||||
### 5.3 Resource Quality Assurance
|
### 5.3. Resource Quality Assurance
|
||||||
|
|
||||||
All resources in our database are:
|
All resources in our database are:
|
||||||
|
|
||||||
@@ -382,7 +382,7 @@ All resources in our database are:
|
|||||||
|
|
||||||
**(h)** **Quality Monitored:** Ongoing monitoring of service quality and availability.
|
**(h)** **Quality Monitored:** Ongoing monitoring of service quality and availability.
|
||||||
|
|
||||||
### 5.4 Resource Presentation Guidelines
|
### 5.4. Resource Presentation Guidelines
|
||||||
|
|
||||||
When providing resources:
|
When providing resources:
|
||||||
|
|
||||||
@@ -404,7 +404,7 @@ When providing resources:
|
|||||||
|
|
||||||
## 6. TEAM TRAINING AND PREPAREDNESS
|
## 6. TEAM TRAINING AND PREPAREDNESS
|
||||||
|
|
||||||
### 6.1 Mandatory Training Requirements
|
### 6.1. Mandatory Training Requirements
|
||||||
|
|
||||||
All team members receive training on:
|
All team members receive training on:
|
||||||
|
|
||||||
@@ -424,7 +424,7 @@ All team members receive training on:
|
|||||||
|
|
||||||
**(h)** **Self-Care Practices:** Managing the emotional impact of crisis work.
|
**(h)** **Self-Care Practices:** Managing the emotional impact of crisis work.
|
||||||
|
|
||||||
### 6.2 Specialised Training for Response Team
|
### 6.2. Specialised Training for Response Team
|
||||||
|
|
||||||
Designated crisis response team members receive additional training in:
|
Designated crisis response team members receive additional training in:
|
||||||
|
|
||||||
@@ -444,7 +444,7 @@ Designated crisis response team members receive additional training in:
|
|||||||
|
|
||||||
**(h)** **Trauma-Informed Approaches:** Understanding trauma impacts on communication.
|
**(h)** **Trauma-Informed Approaches:** Understanding trauma impacts on communication.
|
||||||
|
|
||||||
### 6.3 Ongoing Education and Updates
|
### 6.3. Ongoing Education and Updates
|
||||||
|
|
||||||
Our training programme includes:
|
Our training programme includes:
|
||||||
|
|
||||||
@@ -464,7 +464,7 @@ Our training programme includes:
|
|||||||
|
|
||||||
**(h)** **Performance Review:** Regular assessment of crisis response effectiveness.
|
**(h)** **Performance Review:** Regular assessment of crisis response effectiveness.
|
||||||
|
|
||||||
### 6.4 Support for Team Members
|
### 6.4. Support for Team Members
|
||||||
|
|
||||||
We provide support for team members including:
|
We provide support for team members including:
|
||||||
|
|
||||||
@@ -486,7 +486,7 @@ We provide support for team members including:
|
|||||||
|
|
||||||
## 7. DOCUMENTATION AND RECORD KEEPING
|
## 7. DOCUMENTATION AND RECORD KEEPING
|
||||||
|
|
||||||
### 7.1 Documentation Requirements
|
### 7.1. Documentation Requirements
|
||||||
|
|
||||||
All crisis situations must be documented with:
|
All crisis situations must be documented with:
|
||||||
|
|
||||||
@@ -506,7 +506,7 @@ All crisis situations must be documented with:
|
|||||||
|
|
||||||
**(h)** **Resolution Status:** Current status and any resolution achieved.
|
**(h)** **Resolution Status:** Current status and any resolution achieved.
|
||||||
|
|
||||||
### 7.2 Privacy and Confidentiality
|
### 7.2. Privacy and Confidentiality
|
||||||
|
|
||||||
Crisis documentation must balance thorough record-keeping with privacy:
|
Crisis documentation must balance thorough record-keeping with privacy:
|
||||||
|
|
||||||
@@ -526,7 +526,7 @@ Crisis documentation must balance thorough record-keeping with privacy:
|
|||||||
|
|
||||||
**(h)** **Regular Review:** Regular review of documentation practices for privacy compliance.
|
**(h)** **Regular Review:** Regular review of documentation practices for privacy compliance.
|
||||||
|
|
||||||
### 7.3 Reporting and Analysis
|
### 7.3. Reporting and Analysis
|
||||||
|
|
||||||
We conduct regular analysis of crisis situations to:
|
We conduct regular analysis of crisis situations to:
|
||||||
|
|
||||||
@@ -546,7 +546,7 @@ We conduct regular analysis of crisis situations to:
|
|||||||
|
|
||||||
**(h)** **Legal Compliance:** Ensure ongoing compliance with legal obligations.
|
**(h)** **Legal Compliance:** Ensure ongoing compliance with legal obligations.
|
||||||
|
|
||||||
### 7.4 Quality Assurance
|
### 7.4. Quality Assurance
|
||||||
|
|
||||||
Our documentation system includes:
|
Our documentation system includes:
|
||||||
|
|
||||||
@@ -568,7 +568,7 @@ Our documentation system includes:
|
|||||||
|
|
||||||
## 8. COMMUNITY EDUCATION AND PREVENTION
|
## 8. COMMUNITY EDUCATION AND PREVENTION
|
||||||
|
|
||||||
### 8.1 Mental Health Awareness
|
### 8.1. Mental Health Awareness
|
||||||
|
|
||||||
We promote mental health awareness through:
|
We promote mental health awareness through:
|
||||||
|
|
||||||
@@ -588,7 +588,7 @@ We promote mental health awareness through:
|
|||||||
|
|
||||||
**(h)** **Crisis Prevention:** Educational content about recognising crisis warning signs.
|
**(h)** **Crisis Prevention:** Educational content about recognising crisis warning signs.
|
||||||
|
|
||||||
### 8.2 Community Guidelines for Mental Health Discussions
|
### 8.2. Community Guidelines for Mental Health Discussions
|
||||||
|
|
||||||
Our community guidelines establish:
|
Our community guidelines establish:
|
||||||
|
|
||||||
@@ -608,7 +608,7 @@ Our community guidelines establish:
|
|||||||
|
|
||||||
**(h)** **Harmful Content:** Prohibition on content that could harm vulnerable individuals.
|
**(h)** **Harmful Content:** Prohibition on content that could harm vulnerable individuals.
|
||||||
|
|
||||||
### 8.3 Proactive Support Measures
|
### 8.3. Proactive Support Measures
|
||||||
|
|
||||||
We implement proactive measures including:
|
We implement proactive measures including:
|
||||||
|
|
||||||
@@ -628,13 +628,13 @@ We implement proactive measures including:
|
|||||||
|
|
||||||
**(h)** **Community Connection:** Features that promote healthy community connection.
|
**(h)** **Community Connection:** Features that promote healthy community connection.
|
||||||
|
|
||||||
### 8.4 Partnership Development
|
### 8.4. Partnership Development
|
||||||
|
|
||||||
We develop partnerships with:
|
We develop partnerships with:
|
||||||
|
|
||||||
**(a)** **Mental Health Organisations:** Local and national mental health organisations;
|
**(a)** **Mental Health Organisations:** Local and national mental health organisations;
|
||||||
|
|
||||||
**(b)** **Crisis Centers:** Crisis intervention centres and hotlines;
|
**(b)** **Crisis Centres:** Crisis intervention centres and hotlines;
|
||||||
|
|
||||||
**(c)** **Educational Institutions:** Schools and universities with mental health programmes;
|
**(c)** **Educational Institutions:** Schools and universities with mental health programmes;
|
||||||
|
|
||||||
@@ -650,7 +650,7 @@ We develop partnerships with:
|
|||||||
|
|
||||||
## 9. LEGAL COMPLIANCE AND LIABILITY
|
## 9. LEGAL COMPLIANCE AND LIABILITY
|
||||||
|
|
||||||
### 9.1 Limitation of Liability
|
### 9.1. Limitation of Liability
|
||||||
|
|
||||||
**IMPORTANT LEGAL DISCLAIMERS:**
|
**IMPORTANT LEGAL DISCLAIMERS:**
|
||||||
|
|
||||||
@@ -670,7 +670,7 @@ We develop partnerships with:
|
|||||||
|
|
||||||
**(h)** This policy does not create professional therapeutic relationships.
|
**(h)** This policy does not create professional therapeutic relationships.
|
||||||
|
|
||||||
### 9.2 Duty of Care Limitations
|
### 9.2. Duty of Care Limitations
|
||||||
|
|
||||||
Our duty of care is limited to:
|
Our duty of care is limited to:
|
||||||
|
|
||||||
@@ -690,7 +690,7 @@ Our duty of care is limited to:
|
|||||||
|
|
||||||
**(h)** **Continuous Improvement:** Regular review and improvement of procedures.
|
**(h)** **Continuous Improvement:** Regular review and improvement of procedures.
|
||||||
|
|
||||||
### 9.3 Professional Boundaries
|
### 9.3. Professional Boundaries
|
||||||
|
|
||||||
We maintain clear boundaries by:
|
We maintain clear boundaries by:
|
||||||
|
|
||||||
@@ -710,7 +710,7 @@ We maintain clear boundaries by:
|
|||||||
|
|
||||||
**(h)** **Ethical Standards:** Adhering to ethical standards for non-professional support.
|
**(h)** **Ethical Standards:** Adhering to ethical standards for non-professional support.
|
||||||
|
|
||||||
### 9.4 Legal Consultation Framework
|
### 9.4. Legal Consultation Framework
|
||||||
|
|
||||||
We maintain legal consultation capabilities for:
|
We maintain legal consultation capabilities for:
|
||||||
|
|
||||||
@@ -732,7 +732,7 @@ We maintain legal consultation capabilities for:
|
|||||||
|
|
||||||
## 10. CONTACT INFORMATION AND RESOURCES
|
## 10. CONTACT INFORMATION AND RESOURCES
|
||||||
|
|
||||||
### 10.1 Internal Crisis Response Team
|
### 10.1. Internal Crisis Response Team
|
||||||
|
|
||||||
**Crisis Response Team:** crisis-response@nhcarrigan.com
|
**Crisis Response Team:** crisis-response@nhcarrigan.com
|
||||||
|
|
||||||
@@ -742,7 +742,7 @@ We maintain legal consultation capabilities for:
|
|||||||
|
|
||||||
**24/7 Emergency Escalation:** Available through designated emergency contact procedures
|
**24/7 Emergency Escalation:** Available through designated emergency contact procedures
|
||||||
|
|
||||||
### 10.2 External Emergency Resources
|
### 10.2. External Emergency Resources
|
||||||
|
|
||||||
**IMMEDIATE CRISIS RESOURCES:**
|
**IMMEDIATE CRISIS RESOURCES:**
|
||||||
|
|
||||||
@@ -758,7 +758,7 @@ We maintain legal consultation capabilities for:
|
|||||||
|
|
||||||
**(f)** **Emergency Services:** 911 (US), 999 (UK), 112 (EU), 000 (Australia)
|
**(f)** **Emergency Services:** 911 (US), 999 (UK), 112 (EU), 000 (Australia)
|
||||||
|
|
||||||
### 10.3 Professional Mental Health Resources
|
### 10.3. Professional Mental Health Resources
|
||||||
|
|
||||||
**(a)** **Psychology Today:** https://www.psychologytoday.com
|
**(a)** **Psychology Today:** https://www.psychologytoday.com
|
||||||
|
|
||||||
@@ -770,7 +770,7 @@ We maintain legal consultation capabilities for:
|
|||||||
|
|
||||||
**(e)** **International Association for Suicide Prevention:** https://www.iasp.info
|
**(e)** **International Association for Suicide Prevention:** https://www.iasp.info
|
||||||
|
|
||||||
### 10.4 Community Support and Information
|
### 10.4. Community Support and Information
|
||||||
|
|
||||||
**Community Support:** community@nhcarrigan.com
|
**Community Support:** community@nhcarrigan.com
|
||||||
|
|
||||||
@@ -782,16 +782,6 @@ We maintain legal consultation capabilities for:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 25 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 25 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 25 March 2026
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*This Crisis and Mental Health Management Policy establishes our commitment to supporting community wellbeing whilst maintaining clear professional boundaries. We are not mental health professionals and cannot provide therapeutic services. If you or someone you know is in crisis, please contact emergency services or professional crisis intervention services immediately.*
|
*This Crisis and Mental Health Management Policy establishes our commitment to supporting community wellbeing whilst maintaining clear professional boundaries. We are not mental health professionals and cannot provide therapeutic services. If you or someone you know is in crisis, please contact emergency services or professional crisis intervention services immediately.*
|
||||||
|
|
||||||
**IF YOU ARE IN IMMEDIATE DANGER, CONTACT EMERGENCY SERVICES: 911 (US), 999 (UK), 112 (EU), 000 (Australia)**
|
**IF YOU ARE IN IMMEDIATE DANGER, CONTACT EMERGENCY SERVICES: 911 (US), 999 (UK), 112 (EU), 000 (Australia)**
|
||||||
@@ -6,7 +6,7 @@ title: DMCA and Intellectual Property Compliance Policy
|
|||||||
|
|
||||||
## 1. POLICY OVERVIEW AND PRINCIPLES
|
## 1. POLICY OVERVIEW AND PRINCIPLES
|
||||||
|
|
||||||
### 1.1 Fundamental Principles
|
### 1.1. Fundamental Principles
|
||||||
|
|
||||||
This Digital Millennium Copyright Act and Intellectual Property Compliance Policy ("Policy") is founded upon the following core principles:
|
This Digital Millennium Copyright Act and Intellectual Property Compliance Policy ("Policy") is founded upon the following core principles:
|
||||||
|
|
||||||
@@ -18,7 +18,7 @@ This Digital Millennium Copyright Act and Intellectual Property Compliance Polic
|
|||||||
|
|
||||||
**(d)** Ignorance of applicable law or this Policy does not constitute a valid defence for non-compliance.
|
**(d)** Ignorance of applicable law or this Policy does not constitute a valid defence for non-compliance.
|
||||||
|
|
||||||
### 1.2 Scope of Application
|
### 1.2. Scope of Application
|
||||||
|
|
||||||
This Policy applies to:
|
This Policy applies to:
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ This Policy applies to:
|
|||||||
|
|
||||||
**(d)** All third-party integrations and linked content.
|
**(d)** All third-party integrations and linked content.
|
||||||
|
|
||||||
### 1.3 Legal Framework
|
### 1.3. Legal Framework
|
||||||
|
|
||||||
This Policy is designed to comply with:
|
This Policy is designed to comply with:
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ This Policy is designed to comply with:
|
|||||||
|
|
||||||
## 2. COPYRIGHT PROTECTION AND COMPLIANCE
|
## 2. COPYRIGHT PROTECTION AND COMPLIANCE
|
||||||
|
|
||||||
### 2.1 Prohibition on Unauthorised Sharing
|
### 2.1. Prohibition on Unauthorised Sharing
|
||||||
|
|
||||||
You must not share copyrighted material through our Services unless you have:
|
You must not share copyrighted material through our Services unless you have:
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ You must not share copyrighted material through our Services unless you have:
|
|||||||
|
|
||||||
**(c)** Legal basis for the sharing under applicable copyright exceptions or limitations.
|
**(c)** Legal basis for the sharing under applicable copyright exceptions or limitations.
|
||||||
|
|
||||||
### 2.2 Proper Attribution Requirements
|
### 2.2. Proper Attribution Requirements
|
||||||
|
|
||||||
When sharing material is permitted, you must:
|
When sharing material is permitted, you must:
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ When sharing material is permitted, you must:
|
|||||||
|
|
||||||
**(d)** Clearly indicate any modifications made to the original material.
|
**(d)** Clearly indicate any modifications made to the original material.
|
||||||
|
|
||||||
### 2.3 Linking vs. Copying
|
### 2.3. Linking vs. Copying
|
||||||
|
|
||||||
**(a)** **Permitted Practice:** Linking to legitimately published content is generally acceptable and encouraged;
|
**(a)** **Permitted Practice:** Linking to legitimately published content is generally acceptable and encouraged;
|
||||||
|
|
||||||
@@ -74,7 +74,7 @@ When sharing material is permitted, you must:
|
|||||||
|
|
||||||
**(c)** **User-Generated Content:** Be aware that content posted on social media platforms and similar services may be subject to copyright protection.
|
**(c)** **User-Generated Content:** Be aware that content posted on social media platforms and similar services may be subject to copyright protection.
|
||||||
|
|
||||||
### 2.4 Due Diligence Requirements
|
### 2.4. Due Diligence Requirements
|
||||||
|
|
||||||
When uncertain about the copyright status of material:
|
When uncertain about the copyright status of material:
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ When uncertain about the copyright status of material:
|
|||||||
|
|
||||||
## 3. FAIR USE AND EDUCATIONAL PURPOSES
|
## 3. FAIR USE AND EDUCATIONAL PURPOSES
|
||||||
|
|
||||||
### 3.1 Fair Use Principles
|
### 3.1. Fair Use Principles
|
||||||
|
|
||||||
Limited use of copyrighted material may be permissible under fair use doctrines for:
|
Limited use of copyrighted material may be permissible under fair use doctrines for:
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ Limited use of copyrighted material may be permissible under fair use doctrines
|
|||||||
|
|
||||||
**(d)** Other purposes recognised under applicable fair use provisions.
|
**(d)** Other purposes recognised under applicable fair use provisions.
|
||||||
|
|
||||||
### 3.2 Fair Use Assessment Factors
|
### 3.2. Fair Use Assessment Factors
|
||||||
|
|
||||||
When claiming fair use, you must consider:
|
When claiming fair use, you must consider:
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ When claiming fair use, you must consider:
|
|||||||
|
|
||||||
**(d)** **Market Impact:** The effect of your use on the potential market for the original work.
|
**(d)** **Market Impact:** The effect of your use on the potential market for the original work.
|
||||||
|
|
||||||
### 3.3 Educational Use Clarification
|
### 3.3. Educational Use Clarification
|
||||||
|
|
||||||
**(a)** Educational context does not automatically qualify as fair use;
|
**(a)** Educational context does not automatically qualify as fair use;
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ When claiming fair use, you must consider:
|
|||||||
|
|
||||||
**(d)** Commercial educational uses face higher scrutiny than non-profit educational activities.
|
**(d)** Commercial educational uses face higher scrutiny than non-profit educational activities.
|
||||||
|
|
||||||
### 3.4 Documentation and Source Citation
|
### 3.4. Documentation and Source Citation
|
||||||
|
|
||||||
When relying on fair use:
|
When relying on fair use:
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ When relying on fair use:
|
|||||||
|
|
||||||
## 4. ATTRIBUTION AND CITATION STANDARDS
|
## 4. ATTRIBUTION AND CITATION STANDARDS
|
||||||
|
|
||||||
### 4.1 Mandatory Attribution Elements
|
### 4.1. Mandatory Attribution Elements
|
||||||
|
|
||||||
When using or referencing others' work, you must provide:
|
When using or referencing others' work, you must provide:
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ When using or referencing others' work, you must provide:
|
|||||||
|
|
||||||
**(f)** A clear indication of any modifications made to the original.
|
**(f)** A clear indication of any modifications made to the original.
|
||||||
|
|
||||||
### 4.2 Digital Citation Best Practices
|
### 4.2. Digital Citation Best Practices
|
||||||
|
|
||||||
For digital content:
|
For digital content:
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ For digital content:
|
|||||||
|
|
||||||
**(d)** Follow established citation standards appropriate to your field or context.
|
**(d)** Follow established citation standards appropriate to your field or context.
|
||||||
|
|
||||||
### 4.3 Academic and Professional Citations
|
### 4.3. Academic and Professional Citations
|
||||||
|
|
||||||
When creating academic or professional content:
|
When creating academic or professional content:
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ When creating academic or professional content:
|
|||||||
|
|
||||||
## 5. ORIGINAL CONTENT CREATION AND LICENSING
|
## 5. ORIGINAL CONTENT CREATION AND LICENSING
|
||||||
|
|
||||||
### 5.1 Original Content Rights
|
### 5.1. Original Content Rights
|
||||||
|
|
||||||
When creating and sharing original content through our Services:
|
When creating and sharing original content through our Services:
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ When creating and sharing original content through our Services:
|
|||||||
|
|
||||||
**(d)** Copyright notices may be added to clarify ownership and rights.
|
**(d)** Copyright notices may be added to clarify ownership and rights.
|
||||||
|
|
||||||
### 5.2 Third-Party Content in Original Works
|
### 5.2. Third-Party Content in Original Works
|
||||||
|
|
||||||
When incorporating third-party elements into your original creations:
|
When incorporating third-party elements into your original creations:
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ When incorporating third-party elements into your original creations:
|
|||||||
|
|
||||||
**(d)** Consider the impact on your ability to license the resulting work.
|
**(d)** Consider the impact on your ability to license the resulting work.
|
||||||
|
|
||||||
### 5.3 Community Usage Rights
|
### 5.3. Community Usage Rights
|
||||||
|
|
||||||
By sharing content in our community spaces, you grant:
|
By sharing content in our community spaces, you grant:
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ By sharing content in our community spaces, you grant:
|
|||||||
|
|
||||||
**(d)** Such other rights as may be specified in our Terms of Service.
|
**(d)** Such other rights as may be specified in our Terms of Service.
|
||||||
|
|
||||||
### 5.4 Licensing Recommendations
|
### 5.4. Licensing Recommendations
|
||||||
|
|
||||||
We encourage content creators to:
|
We encourage content creators to:
|
||||||
|
|
||||||
@@ -228,7 +228,7 @@ We encourage content creators to:
|
|||||||
|
|
||||||
## 6. OPEN SOURCE AND CREATIVE COMMONS COMPLIANCE
|
## 6. OPEN SOURCE AND CREATIVE COMMONS COMPLIANCE
|
||||||
|
|
||||||
### 6.1 Open Source Software
|
### 6.1. Open Source Software
|
||||||
|
|
||||||
When using open source software:
|
When using open source software:
|
||||||
|
|
||||||
@@ -240,7 +240,7 @@ When using open source software:
|
|||||||
|
|
||||||
**(d)** Be aware of licence compatibility issues when combining multiple open source components.
|
**(d)** Be aware of licence compatibility issues when combining multiple open source components.
|
||||||
|
|
||||||
### 6.2 Creative Commons Materials
|
### 6.2. Creative Commons Materials
|
||||||
|
|
||||||
When using Creative Commons licensed content:
|
When using Creative Commons licensed content:
|
||||||
|
|
||||||
@@ -254,7 +254,7 @@ When using Creative Commons licensed content:
|
|||||||
|
|
||||||
**(e)** Understand the implications of no-derivatives restrictions.
|
**(e)** Understand the implications of no-derivatives restrictions.
|
||||||
|
|
||||||
### 6.3 Licence Verification
|
### 6.3. Licence Verification
|
||||||
|
|
||||||
**(a)** Verify licence information from authoritative sources;
|
**(a)** Verify licence information from authoritative sources;
|
||||||
|
|
||||||
@@ -264,7 +264,7 @@ When using Creative Commons licensed content:
|
|||||||
|
|
||||||
**(d)** Maintain records of your licence compliance efforts.
|
**(d)** Maintain records of your licence compliance efforts.
|
||||||
|
|
||||||
### 6.4 Contributing to Open Projects
|
### 6.4. Contributing to Open Projects
|
||||||
|
|
||||||
When contributing to open source or Creative Commons projects:
|
When contributing to open source or Creative Commons projects:
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ When contributing to open source or Creative Commons projects:
|
|||||||
|
|
||||||
## 7. CODE SHARING AND TECHNICAL CONTENT
|
## 7. CODE SHARING AND TECHNICAL CONTENT
|
||||||
|
|
||||||
### 7.1 Code Snippets and Examples
|
### 7.1. Code Snippets and Examples
|
||||||
|
|
||||||
**(a)** **Short Code Snippets:** Generally acceptable under fair use for educational or troubleshooting purposes;
|
**(a)** **Short Code Snippets:** Generally acceptable under fair use for educational or troubleshooting purposes;
|
||||||
|
|
||||||
@@ -288,7 +288,7 @@ When contributing to open source or Creative Commons projects:
|
|||||||
|
|
||||||
**(d)** **Modified Code:** Must respect original licence requirements and indicate modifications.
|
**(d)** **Modified Code:** Must respect original licence requirements and indicate modifications.
|
||||||
|
|
||||||
### 7.2 Educational Code Sharing
|
### 7.2. Educational Code Sharing
|
||||||
|
|
||||||
When sharing code for educational purposes:
|
When sharing code for educational purposes:
|
||||||
|
|
||||||
@@ -300,7 +300,7 @@ When sharing code for educational purposes:
|
|||||||
|
|
||||||
**(d)** Respect any restrictions on commercial use or redistribution.
|
**(d)** Respect any restrictions on commercial use or redistribution.
|
||||||
|
|
||||||
### 7.3 Technical Documentation
|
### 7.3. Technical Documentation
|
||||||
|
|
||||||
**(a)** Original technical documentation is encouraged and valued;
|
**(a)** Original technical documentation is encouraged and valued;
|
||||||
|
|
||||||
@@ -310,7 +310,7 @@ When sharing code for educational purposes:
|
|||||||
|
|
||||||
**(d)** Consider creating transformative content rather than copying existing documentation.
|
**(d)** Consider creating transformative content rather than copying existing documentation.
|
||||||
|
|
||||||
### 7.4 Open Source Best Practices
|
### 7.4. Open Source Best Practices
|
||||||
|
|
||||||
When sharing your own code:
|
When sharing your own code:
|
||||||
|
|
||||||
@@ -324,7 +324,7 @@ When sharing your own code:
|
|||||||
|
|
||||||
## 8. PLAGIARISM PREVENTION AND ACADEMIC INTEGRITY
|
## 8. PLAGIARISM PREVENTION AND ACADEMIC INTEGRITY
|
||||||
|
|
||||||
### 8.1 Definition and Prohibition
|
### 8.1. Definition and Prohibition
|
||||||
|
|
||||||
Plagiarism, defined as presenting others' work as your own, is strictly prohibited and includes:
|
Plagiarism, defined as presenting others' work as your own, is strictly prohibited and includes:
|
||||||
|
|
||||||
@@ -336,7 +336,7 @@ Plagiarism, defined as presenting others' work as your own, is strictly prohibit
|
|||||||
|
|
||||||
**(d)** Self-plagiarism (reusing your own previously published work without disclosure).
|
**(d)** Self-plagiarism (reusing your own previously published work without disclosure).
|
||||||
|
|
||||||
### 8.2 Consequences of Plagiarism
|
### 8.2. Consequences of Plagiarism
|
||||||
|
|
||||||
Plagiarism may result in:
|
Plagiarism may result in:
|
||||||
|
|
||||||
@@ -350,7 +350,7 @@ Plagiarism may result in:
|
|||||||
|
|
||||||
**(e)** Permanent record of violation affecting future community participation.
|
**(e)** Permanent record of violation affecting future community participation.
|
||||||
|
|
||||||
### 8.3 Prevention Measures
|
### 8.3. Prevention Measures
|
||||||
|
|
||||||
To avoid plagiarism:
|
To avoid plagiarism:
|
||||||
|
|
||||||
@@ -364,7 +364,7 @@ To avoid plagiarism:
|
|||||||
|
|
||||||
**(e)** When in doubt, provide attribution rather than risk infringement.
|
**(e)** When in doubt, provide attribution rather than risk infringement.
|
||||||
|
|
||||||
### 8.4 Academic and Professional Standards
|
### 8.4. Academic and Professional Standards
|
||||||
|
|
||||||
**(a)** Follow the citation standards appropriate to your field or institution;
|
**(a)** Follow the citation standards appropriate to your field or institution;
|
||||||
|
|
||||||
@@ -376,7 +376,7 @@ To avoid plagiarism:
|
|||||||
|
|
||||||
## 9. TRADEMARK COMPLIANCE
|
## 9. TRADEMARK COMPLIANCE
|
||||||
|
|
||||||
### 9.1 Trademark Recognition and Respect
|
### 9.1. Trademark Recognition and Respect
|
||||||
|
|
||||||
When referencing trademarked products, services, or organisations:
|
When referencing trademarked products, services, or organisations:
|
||||||
|
|
||||||
@@ -388,7 +388,7 @@ When referencing trademarked products, services, or organisations:
|
|||||||
|
|
||||||
**(d)** Respect trademark guidelines published by trademark owners.
|
**(d)** Respect trademark guidelines published by trademark owners.
|
||||||
|
|
||||||
### 9.2 Nominative Fair Use
|
### 9.2. Nominative Fair Use
|
||||||
|
|
||||||
You may use trademarks for:
|
You may use trademarks for:
|
||||||
|
|
||||||
@@ -400,7 +400,7 @@ You may use trademarks for:
|
|||||||
|
|
||||||
**(d)** Parody and criticism (with careful consideration of other legal restrictions).
|
**(d)** Parody and criticism (with careful consideration of other legal restrictions).
|
||||||
|
|
||||||
### 9.3 Prohibited Trademark Uses
|
### 9.3. Prohibited Trademark Uses
|
||||||
|
|
||||||
You must not:
|
You must not:
|
||||||
|
|
||||||
@@ -412,7 +412,7 @@ You must not:
|
|||||||
|
|
||||||
**(d)** Use trademarks in a way that dilutes their distinctiveness or harms their reputation.
|
**(d)** Use trademarks in a way that dilutes their distinctiveness or harms their reputation.
|
||||||
|
|
||||||
### 9.4 Community Brand Protection
|
### 9.4. Community Brand Protection
|
||||||
|
|
||||||
**(a)** Respect our own trademarks and brand elements;
|
**(a)** Respect our own trademarks and brand elements;
|
||||||
|
|
||||||
@@ -424,11 +424,11 @@ You must not:
|
|||||||
|
|
||||||
## 10. DMCA COMPLIANCE AND TAKEDOWN PROCEDURES
|
## 10. DMCA COMPLIANCE AND TAKEDOWN PROCEDURES
|
||||||
|
|
||||||
### 10.1 DMCA Policy Statement
|
### 10.1. DMCA Policy Statement
|
||||||
|
|
||||||
We comply with the Digital Millennium Copyright Act and maintain procedures for addressing claims of copyright infringement. We respect the rights of copyright owners whilst protecting the legitimate interests of our users.
|
We comply with the Digital Millennium Copyright Act and maintain procedures for addressing claims of copyright infringement. We respect the rights of copyright owners whilst protecting the legitimate interests of our users.
|
||||||
|
|
||||||
### 10.2 Submitting DMCA Takedown Notices
|
### 10.2. Submitting DMCA Takedown Notices
|
||||||
|
|
||||||
To submit a valid DMCA takedown notice, contact **dmca@nhcarrigan.com** with the following information:
|
To submit a valid DMCA takedown notice, contact **dmca@nhcarrigan.com** with the following information:
|
||||||
|
|
||||||
@@ -444,7 +444,7 @@ To submit a valid DMCA takedown notice, contact **dmca@nhcarrigan.com** with the
|
|||||||
|
|
||||||
**(f)** **Physical or Electronic Signature:** Your physical or electronic signature.
|
**(f)** **Physical or Electronic Signature:** Your physical or electronic signature.
|
||||||
|
|
||||||
### 10.3 Processing DMCA Notices
|
### 10.3. Processing DMCA Notices
|
||||||
|
|
||||||
Upon receipt of a valid DMCA takedown notice:
|
Upon receipt of a valid DMCA takedown notice:
|
||||||
|
|
||||||
@@ -456,7 +456,7 @@ Upon receipt of a valid DMCA takedown notice:
|
|||||||
|
|
||||||
**(d)** We will document the takedown for our records and potential future reference.
|
**(d)** We will document the takedown for our records and potential future reference.
|
||||||
|
|
||||||
### 10.4 Response Timeline
|
### 10.4. Response Timeline
|
||||||
|
|
||||||
We endeavour to process DMCA takedown notices within:
|
We endeavour to process DMCA takedown notices within:
|
||||||
|
|
||||||
@@ -468,11 +468,11 @@ We endeavour to process DMCA takedown notices within:
|
|||||||
|
|
||||||
## 11. DMCA COUNTER-NOTIFICATION PROCESS
|
## 11. DMCA COUNTER-NOTIFICATION PROCESS
|
||||||
|
|
||||||
### 11.1 Right to Counter-Notification
|
### 11.1. Right to Counter-Notification
|
||||||
|
|
||||||
If you believe your content was removed in error or misidentification, you may submit a counter-notification to **dmca@nhcarrigan.com**.
|
If you believe your content was removed in error or misidentification, you may submit a counter-notification to **dmca@nhcarrigan.com**.
|
||||||
|
|
||||||
### 11.2 Counter-Notification Requirements
|
### 11.2. Counter-Notification Requirements
|
||||||
|
|
||||||
A valid counter-notification must include:
|
A valid counter-notification must include:
|
||||||
|
|
||||||
@@ -488,7 +488,7 @@ A valid counter-notification must include:
|
|||||||
|
|
||||||
**(f)** **Physical or Electronic Signature:** Your physical or electronic signature.
|
**(f)** **Physical or Electronic Signature:** Your physical or electronic signature.
|
||||||
|
|
||||||
### 11.3 Counter-Notification Processing
|
### 11.3. Counter-Notification Processing
|
||||||
|
|
||||||
Upon receipt of a valid counter-notification:
|
Upon receipt of a valid counter-notification:
|
||||||
|
|
||||||
@@ -500,17 +500,17 @@ Upon receipt of a valid counter-notification:
|
|||||||
|
|
||||||
**(d)** We will document the counter-notification and restoration for our records.
|
**(d)** We will document the counter-notification and restoration for our records.
|
||||||
|
|
||||||
### 11.4 Legal Consequences
|
### 11.4. Legal Consequences
|
||||||
|
|
||||||
Both takedown notices and counter-notifications are made under penalty of perjury. False claims may result in liability for damages, attorney's fees, and other legal consequences under applicable law.
|
Both takedown notices and counter-notifications are made under penalty of perjury. False claims may result in liability for damages, attorney's fees, and other legal consequences under applicable law.
|
||||||
|
|
||||||
## 12. REPEAT INFRINGER POLICY
|
## 12. REPEAT INFRINGER POLICY
|
||||||
|
|
||||||
### 12.1 Policy Statement
|
### 12.1. Policy Statement
|
||||||
|
|
||||||
We maintain a policy for addressing repeat copyright infringers to ensure ongoing DMCA compliance and protect the rights of copyright holders.
|
We maintain a policy for addressing repeat copyright infringers to ensure ongoing DMCA compliance and protect the rights of copyright holders.
|
||||||
|
|
||||||
### 12.2 Tracking and Documentation
|
### 12.2. Tracking and Documentation
|
||||||
|
|
||||||
We maintain records of:
|
We maintain records of:
|
||||||
|
|
||||||
@@ -522,7 +522,7 @@ We maintain records of:
|
|||||||
|
|
||||||
**(d)** User violation history and patterns.
|
**(d)** User violation history and patterns.
|
||||||
|
|
||||||
### 12.3 Consequences for Repeat Infringement
|
### 12.3. Consequences for Repeat Infringement
|
||||||
|
|
||||||
Users who repeatedly infringe copyright may face:
|
Users who repeatedly infringe copyright may face:
|
||||||
|
|
||||||
@@ -534,7 +534,7 @@ Users who repeatedly infringe copyright may face:
|
|||||||
|
|
||||||
**(d)** **Severe Cases:** Immediate termination for egregious or commercial infringement.
|
**(d)** **Severe Cases:** Immediate termination for egregious or commercial infringement.
|
||||||
|
|
||||||
### 12.4 Appeals Process
|
### 12.4. Appeals Process
|
||||||
|
|
||||||
Users subject to repeat infringer sanctions may:
|
Users subject to repeat infringer sanctions may:
|
||||||
|
|
||||||
@@ -548,7 +548,7 @@ Users subject to repeat infringer sanctions may:
|
|||||||
|
|
||||||
## 13. EDUCATION AND AWARENESS
|
## 13. EDUCATION AND AWARENESS
|
||||||
|
|
||||||
### 13.1 Community Education Commitment
|
### 13.1. Community Education Commitment
|
||||||
|
|
||||||
We are committed to educating our community about intellectual property rights and responsibilities through:
|
We are committed to educating our community about intellectual property rights and responsibilities through:
|
||||||
|
|
||||||
@@ -560,7 +560,7 @@ We are committed to educating our community about intellectual property rights a
|
|||||||
|
|
||||||
**(d)** Clear examples of acceptable and unacceptable practices.
|
**(d)** Clear examples of acceptable and unacceptable practices.
|
||||||
|
|
||||||
### 13.2 Resources and Guidance
|
### 13.2. Resources and Guidance
|
||||||
|
|
||||||
We provide access to:
|
We provide access to:
|
||||||
|
|
||||||
@@ -572,7 +572,7 @@ We provide access to:
|
|||||||
|
|
||||||
**(d)** Contact information for additional support and guidance.
|
**(d)** Contact information for additional support and guidance.
|
||||||
|
|
||||||
### 13.3 Seeking Clarification
|
### 13.3. Seeking Clarification
|
||||||
|
|
||||||
Community members are encouraged to:
|
Community members are encouraged to:
|
||||||
|
|
||||||
@@ -584,7 +584,7 @@ Community members are encouraged to:
|
|||||||
|
|
||||||
**(d)** Participate in educational activities and discussions.
|
**(d)** Participate in educational activities and discussions.
|
||||||
|
|
||||||
### 13.4 Professional Development
|
### 13.4. Professional Development
|
||||||
|
|
||||||
We encourage community members to:
|
We encourage community members to:
|
||||||
|
|
||||||
@@ -598,7 +598,7 @@ We encourage community members to:
|
|||||||
|
|
||||||
## 14. POLICY UPDATES AND COMPLIANCE
|
## 14. POLICY UPDATES AND COMPLIANCE
|
||||||
|
|
||||||
### 14.1 Regular Policy Review
|
### 14.1. Regular Policy Review
|
||||||
|
|
||||||
This Policy is reviewed regularly to ensure:
|
This Policy is reviewed regularly to ensure:
|
||||||
|
|
||||||
@@ -610,7 +610,7 @@ This Policy is reviewed regularly to ensure:
|
|||||||
|
|
||||||
**(d)** Consistency with best practices in the field.
|
**(d)** Consistency with best practices in the field.
|
||||||
|
|
||||||
### 14.2 Update Notifications
|
### 14.2. Update Notifications
|
||||||
|
|
||||||
Changes to this Policy will be communicated through:
|
Changes to this Policy will be communicated through:
|
||||||
|
|
||||||
@@ -622,31 +622,31 @@ Changes to this Policy will be communicated through:
|
|||||||
|
|
||||||
**(d)** Documentation updates with clear change logs.
|
**(d)** Documentation updates with clear change logs.
|
||||||
|
|
||||||
### 14.3 Continued Use and Acceptance
|
### 14.3. Continued Use and Acceptance
|
||||||
|
|
||||||
Continued participation in our community following Policy updates constitutes acceptance of the revised terms. If you do not agree to the updated Policy, you must cease using our Services.
|
Continued participation in our community following Policy updates constitutes acceptance of the revised terms. If you do not agree to the updated Policy, you must cease using our Services.
|
||||||
|
|
||||||
### 14.4 Feedback and Suggestions
|
### 14.4. Feedback and Suggestions
|
||||||
|
|
||||||
We welcome feedback on this Policy and suggestions for improvement. Please contact us at **dmca@nhcarrigan.com** with your comments and recommendations.
|
We welcome feedback on this Policy and suggestions for improvement. Please contact us at **dmca@nhcarrigan.com** with your comments and recommendations.
|
||||||
|
|
||||||
## 15. CONTACT INFORMATION AND SUPPORT
|
## 15. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 15.1 Primary Contact
|
### 15.1. Primary Contact
|
||||||
|
|
||||||
For all matters related to this Policy, including DMCA notices, questions, and reports of violations:
|
For all matters related to this Policy, including DMCA notices, questions, and reports of violations:
|
||||||
|
|
||||||
**Email:** dmca@nhcarrigan.com
|
**Email:** dmca@nhcarrigan.com
|
||||||
|
|
||||||
### 15.2 Additional Resources
|
### 15.2. Additional Resources
|
||||||
|
|
||||||
**General Support:** privacy@nhcarrigan.com
|
**General Support:** privacy@nhcarrigan.com
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Legal Inquiries:** legal@nhcarrigan.com
|
**Legal Inquiries:** legal@nhcarrigan.com
|
||||||
|
|
||||||
### 15.3 Response Commitments
|
### 15.3. Response Commitments
|
||||||
|
|
||||||
We commit to:
|
We commit to:
|
||||||
|
|
||||||
@@ -658,7 +658,7 @@ We commit to:
|
|||||||
|
|
||||||
**(d)** Maintaining accurate records of all communications and actions taken.
|
**(d)** Maintaining accurate records of all communications and actions taken.
|
||||||
|
|
||||||
### 15.4 Emergency Procedures
|
### 15.4. Emergency Procedures
|
||||||
|
|
||||||
For urgent copyright infringement matters that pose immediate legal risk:
|
For urgent copyright infringement matters that pose immediate legal risk:
|
||||||
|
|
||||||
@@ -672,7 +672,7 @@ For urgent copyright infringement matters that pose immediate legal risk:
|
|||||||
|
|
||||||
## 16. LEGAL DISCLAIMER
|
## 16. LEGAL DISCLAIMER
|
||||||
|
|
||||||
### 16.1 Policy Limitations
|
### 16.1. Policy Limitations
|
||||||
|
|
||||||
This Policy:
|
This Policy:
|
||||||
|
|
||||||
@@ -684,7 +684,7 @@ This Policy:
|
|||||||
|
|
||||||
**(d)** May not address all applicable laws in every jurisdiction.
|
**(d)** May not address all applicable laws in every jurisdiction.
|
||||||
|
|
||||||
### 16.2 Professional Consultation
|
### 16.2. Professional Consultation
|
||||||
|
|
||||||
Users are encouraged to:
|
Users are encouraged to:
|
||||||
|
|
||||||
@@ -696,7 +696,7 @@ Users are encouraged to:
|
|||||||
|
|
||||||
**(d)** Understand that our guidance cannot replace professional legal advice.
|
**(d)** Understand that our guidance cannot replace professional legal advice.
|
||||||
|
|
||||||
### 16.3 Limitation of Liability
|
### 16.3. Limitation of Liability
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive liability limitations and warranty disclaimers applicable to this Policy and all our services are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
**IMPORTANT: Comprehensive liability limitations and warranty disclaimers applicable to this Policy and all our services are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
@@ -708,9 +708,7 @@ In addition to those comprehensive protections:
|
|||||||
|
|
||||||
**(c)** Professional legal advice should be sought for significant legal decisions.
|
**(c)** Professional legal advice should be sought for significant legal decisions.
|
||||||
|
|
||||||
**Last Updated:** [Date to be inserted]
|
|
||||||
|
|
||||||
**Effective Date:** [Date to be inserted]
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Export Control and Sanctions Compliance Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Purpose and Objectives
|
### 1.1. Policy Purpose and Objectives
|
||||||
|
|
||||||
This Export Control and Sanctions Compliance Policy ("Policy") establishes comprehensive procedures and requirements for compliance with export control laws, economic sanctions programmes, and international trade regulations applicable to nhcarrigan ("we," "us," "our," or "the Company") and users of our services, applications, and platforms (collectively, the "Services"). This Policy ensures lawful international distribution and use of our technology and services whilst preventing unauthorised access by restricted parties.
|
This Export Control and Sanctions Compliance Policy ("Policy") establishes comprehensive procedures and requirements for compliance with export control laws, economic sanctions programmes, and international trade regulations applicable to NHCarrigan ("we," "us," "our," or "the Company") and users of our services, applications, and platforms (collectively, the "Services"). This Policy ensures lawful international distribution and use of our technology and services whilst preventing unauthorised access by restricted parties.
|
||||||
|
|
||||||
### 1.2 Regulatory Framework
|
### 1.2. Regulatory Framework
|
||||||
|
|
||||||
This Policy addresses compliance with multiple regulatory regimes including:
|
This Policy addresses compliance with multiple regulatory regimes including:
|
||||||
|
|
||||||
@@ -30,11 +30,11 @@ This Policy addresses compliance with multiple regulatory regimes including:
|
|||||||
|
|
||||||
**(h)** **Emerging Regulations**: New and evolving export control and sanctions regulations worldwide.
|
**(h)** **Emerging Regulations**: New and evolving export control and sanctions regulations worldwide.
|
||||||
|
|
||||||
### 1.3 Application and Scope
|
### 1.3. Application and Scope
|
||||||
|
|
||||||
This Policy applies to:
|
This Policy applies to:
|
||||||
|
|
||||||
**(a)** **Technology Services**: All software, applications, cloud services, and digital technologies provided by nhcarrigan;
|
**(a)** **Technology Services**: All software, applications, cloud services, and digital technologies provided by NHCarrigan;
|
||||||
|
|
||||||
**(b)** **Data and Information**: Technical data, source code, algorithms, and proprietary information;
|
**(b)** **Data and Information**: Technical data, source code, algorithms, and proprietary information;
|
||||||
|
|
||||||
@@ -50,9 +50,9 @@ This Policy applies to:
|
|||||||
|
|
||||||
**(h)** **Research and Development**: Research collaborations, technical exchanges, and development partnerships.
|
**(h)** **Research and Development**: Research collaborations, technical exchanges, and development partnerships.
|
||||||
|
|
||||||
### 1.4 Compliance Commitment
|
### 1.4. Compliance Commitment
|
||||||
|
|
||||||
nhcarrigan is committed to:
|
NHCarrigan is committed to:
|
||||||
|
|
||||||
**(a)** **Legal Compliance**: Full compliance with all applicable export control and sanctions laws;
|
**(a)** **Legal Compliance**: Full compliance with all applicable export control and sanctions laws;
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ nhcarrigan is committed to:
|
|||||||
|
|
||||||
## 2. CLASSIFICATION AND CONTROL DETERMINATIONS
|
## 2. CLASSIFICATION AND CONTROL DETERMINATIONS
|
||||||
|
|
||||||
### 2.1 Technology Classification
|
### 2.1. Technology Classification
|
||||||
|
|
||||||
We have classified our technology and services according to applicable export control regulations:
|
We have classified our technology and services according to applicable export control regulations:
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ We have classified our technology and services according to applicable export co
|
|||||||
|
|
||||||
**(h)** **Third-Party Components**: Third-party software components and dependencies are evaluated for their export control implications.
|
**(h)** **Third-Party Components**: Third-party software components and dependencies are evaluated for their export control implications.
|
||||||
|
|
||||||
### 2.2 Control Determinations
|
### 2.2. Control Determinations
|
||||||
|
|
||||||
Based on classification analysis, our services are subject to the following control determinations:
|
Based on classification analysis, our services are subject to the following control determinations:
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ Based on classification analysis, our services are subject to the following cont
|
|||||||
|
|
||||||
**(h)** **Artificial Intelligence**: AI and machine learning capabilities may be subject to emerging export control regulations.
|
**(h)** **Artificial Intelligence**: AI and machine learning capabilities may be subject to emerging export control regulations.
|
||||||
|
|
||||||
### 2.3 License Requirements and Exceptions
|
### 2.3. License Requirements and Exceptions
|
||||||
|
|
||||||
We utilise the following licensing approaches:
|
We utilise the following licensing approaches:
|
||||||
|
|
||||||
@@ -132,7 +132,7 @@ We utilise the following licensing approaches:
|
|||||||
|
|
||||||
**(h)** **Transit Licences**: We obtain transit licences when required for temporary presence in controlled jurisdictions.
|
**(h)** **Transit Licences**: We obtain transit licences when required for temporary presence in controlled jurisdictions.
|
||||||
|
|
||||||
### 2.4 Ongoing Classification Reviews
|
### 2.4. Ongoing Classification Reviews
|
||||||
|
|
||||||
We maintain ongoing classification reviews through:
|
We maintain ongoing classification reviews through:
|
||||||
|
|
||||||
@@ -154,7 +154,7 @@ We maintain ongoing classification reviews through:
|
|||||||
|
|
||||||
## 3. SANCTIONS COMPLIANCE PROGRAMME
|
## 3. SANCTIONS COMPLIANCE PROGRAMME
|
||||||
|
|
||||||
### 3.1 Sanctions Screening and Monitoring
|
### 3.1. Sanctions Screening and Monitoring
|
||||||
|
|
||||||
We implement comprehensive sanctions screening including:
|
We implement comprehensive sanctions screening including:
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ We implement comprehensive sanctions screening including:
|
|||||||
|
|
||||||
**(h)** **Third-Party Screening**: Screening of all third-party service providers and business partners.
|
**(h)** **Third-Party Screening**: Screening of all third-party service providers and business partners.
|
||||||
|
|
||||||
### 3.2 Prohibited Parties and Jurisdictions
|
### 3.2. Prohibited Parties and Jurisdictions
|
||||||
|
|
||||||
We maintain comprehensive restrictions on:
|
We maintain comprehensive restrictions on:
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ We maintain comprehensive restrictions on:
|
|||||||
|
|
||||||
**(h)** **Shell Companies**: Shell companies or entities designed to circumvent sanctions restrictions.
|
**(h)** **Shell Companies**: Shell companies or entities designed to circumvent sanctions restrictions.
|
||||||
|
|
||||||
### 3.3 Geographic Restrictions
|
### 3.3. Geographic Restrictions
|
||||||
|
|
||||||
Our services are subject to geographic restrictions including:
|
Our services are subject to geographic restrictions including:
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ Our services are subject to geographic restrictions including:
|
|||||||
|
|
||||||
**(h)** **Payment Restrictions**: Restrictions on payment processing for certain jurisdictions.
|
**(h)** **Payment Restrictions**: Restrictions on payment processing for certain jurisdictions.
|
||||||
|
|
||||||
### 3.4 Sanctions Violation Response
|
### 3.4. Sanctions Violation Response
|
||||||
|
|
||||||
When potential sanctions violations are identified:
|
When potential sanctions violations are identified:
|
||||||
|
|
||||||
@@ -236,7 +236,7 @@ When potential sanctions violations are identified:
|
|||||||
|
|
||||||
## 4. USER AND CUSTOMER COMPLIANCE
|
## 4. USER AND CUSTOMER COMPLIANCE
|
||||||
|
|
||||||
### 4.1 User Registration and Verification
|
### 4.1. User Registration and Verification
|
||||||
|
|
||||||
All users must comply with our registration and verification procedures:
|
All users must comply with our registration and verification procedures:
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ All users must comply with our registration and verification procedures:
|
|||||||
|
|
||||||
**(h)** **Ongoing Obligations**: Acceptance of ongoing compliance obligations and monitoring requirements.
|
**(h)** **Ongoing Obligations**: Acceptance of ongoing compliance obligations and monitoring requirements.
|
||||||
|
|
||||||
### 4.2 Prohibited End Uses and End Users
|
### 4.2. Prohibited End Uses and End Users
|
||||||
|
|
||||||
Users are prohibited from:
|
Users are prohibited from:
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ Users are prohibited from:
|
|||||||
|
|
||||||
**(h)** **Unauthorised Transfers**: Transfers to prohibited parties or for prohibited end uses.
|
**(h)** **Unauthorised Transfers**: Transfers to prohibited parties or for prohibited end uses.
|
||||||
|
|
||||||
### 4.3 User Compliance Obligations
|
### 4.3. User Compliance Obligations
|
||||||
|
|
||||||
All users agree to:
|
All users agree to:
|
||||||
|
|
||||||
@@ -296,7 +296,7 @@ All users agree to:
|
|||||||
|
|
||||||
**(h)** **Audit Rights**: Accept our right to audit compliance with export control and sanctions obligations.
|
**(h)** **Audit Rights**: Accept our right to audit compliance with export control and sanctions obligations.
|
||||||
|
|
||||||
### 4.4 Enhanced Due Diligence Requirements
|
### 4.4. Enhanced Due Diligence Requirements
|
||||||
|
|
||||||
For certain users and transactions, we implement enhanced due diligence including:
|
For certain users and transactions, we implement enhanced due diligence including:
|
||||||
|
|
||||||
@@ -318,7 +318,7 @@ For certain users and transactions, we implement enhanced due diligence includin
|
|||||||
|
|
||||||
## 5. TECHNOLOGY TRANSFER CONTROLS
|
## 5. TECHNOLOGY TRANSFER CONTROLS
|
||||||
|
|
||||||
### 5.1 Technical Data and Source Code
|
### 5.1. Technical Data and Source Code
|
||||||
|
|
||||||
Transfer of technical data and source code is subject to:
|
Transfer of technical data and source code is subject to:
|
||||||
|
|
||||||
@@ -338,7 +338,7 @@ Transfer of technical data and source code is subject to:
|
|||||||
|
|
||||||
**(h)** **Retention Policies**: Implementation of appropriate retention and deletion policies for technical data.
|
**(h)** **Retention Policies**: Implementation of appropriate retention and deletion policies for technical data.
|
||||||
|
|
||||||
### 5.2 Foreign National Employee Controls
|
### 5.2. Foreign National Employee Controls
|
||||||
|
|
||||||
For foreign national employees and contractors:
|
For foreign national employees and contractors:
|
||||||
|
|
||||||
@@ -358,7 +358,7 @@ For foreign national employees and contractors:
|
|||||||
|
|
||||||
**(h)** **Termination Procedures**: Appropriate procedures for termination and technology access revocation.
|
**(h)** **Termination Procedures**: Appropriate procedures for termination and technology access revocation.
|
||||||
|
|
||||||
### 5.3 Research and Development Collaborations
|
### 5.3. Research and Development Collaborations
|
||||||
|
|
||||||
For research and development activities:
|
For research and development activities:
|
||||||
|
|
||||||
@@ -378,7 +378,7 @@ For research and development activities:
|
|||||||
|
|
||||||
**(h)** **Government Funding**: Compliance with government funding requirements and restrictions.
|
**(h)** **Government Funding**: Compliance with government funding requirements and restrictions.
|
||||||
|
|
||||||
### 5.4 Cloud and Remote Services
|
### 5.4. Cloud and Remote Services
|
||||||
|
|
||||||
For cloud and remote service provision:
|
For cloud and remote service provision:
|
||||||
|
|
||||||
@@ -400,7 +400,7 @@ For cloud and remote service provision:
|
|||||||
|
|
||||||
## 6. COMPLIANCE MONITORING AND ENFORCEMENT
|
## 6. COMPLIANCE MONITORING AND ENFORCEMENT
|
||||||
|
|
||||||
### 6.1 Automated Monitoring Systems
|
### 6.1. Automated Monitoring Systems
|
||||||
|
|
||||||
We employ automated systems for compliance monitoring including:
|
We employ automated systems for compliance monitoring including:
|
||||||
|
|
||||||
@@ -420,7 +420,7 @@ We employ automated systems for compliance monitoring including:
|
|||||||
|
|
||||||
**(h)** **Integration Systems**: Integration with government databases and sanctions list feeds.
|
**(h)** **Integration Systems**: Integration with government databases and sanctions list feeds.
|
||||||
|
|
||||||
### 6.2 Manual Review Procedures
|
### 6.2. Manual Review Procedures
|
||||||
|
|
||||||
Supplementing automated systems, we maintain manual review procedures including:
|
Supplementing automated systems, we maintain manual review procedures including:
|
||||||
|
|
||||||
@@ -440,7 +440,7 @@ Supplementing automated systems, we maintain manual review procedures including:
|
|||||||
|
|
||||||
**(h)** **Continuous Improvement**: Continuous improvement of manual review processes and procedures.
|
**(h)** **Continuous Improvement**: Continuous improvement of manual review processes and procedures.
|
||||||
|
|
||||||
### 6.3 Violation Detection and Response
|
### 6.3. Violation Detection and Response
|
||||||
|
|
||||||
When potential violations are detected:
|
When potential violations are detected:
|
||||||
|
|
||||||
@@ -460,7 +460,7 @@ When potential violations are detected:
|
|||||||
|
|
||||||
**(h)** **Stakeholder Communication**: Appropriate communication with stakeholders regarding violations and response.
|
**(h)** **Stakeholder Communication**: Appropriate communication with stakeholders regarding violations and response.
|
||||||
|
|
||||||
### 6.4 Enforcement Actions
|
### 6.4. Enforcement Actions
|
||||||
|
|
||||||
Compliance violations may result in:
|
Compliance violations may result in:
|
||||||
|
|
||||||
@@ -482,7 +482,7 @@ Compliance violations may result in:
|
|||||||
|
|
||||||
## 7. TRAINING AND AWARENESS
|
## 7. TRAINING AND AWARENESS
|
||||||
|
|
||||||
### 7.1 Employee Training Programmes
|
### 7.1. Employee Training Programmes
|
||||||
|
|
||||||
All employees receive comprehensive export control and sanctions training including:
|
All employees receive comprehensive export control and sanctions training including:
|
||||||
|
|
||||||
@@ -502,7 +502,7 @@ All employees receive comprehensive export control and sanctions training includ
|
|||||||
|
|
||||||
**(h)** **Certification Programmes**: Support for professional certification in export control and sanctions compliance.
|
**(h)** **Certification Programmes**: Support for professional certification in export control and sanctions compliance.
|
||||||
|
|
||||||
### 7.2 Management and Leadership Training
|
### 7.2. Management and Leadership Training
|
||||||
|
|
||||||
Management and leadership receive enhanced training including:
|
Management and leadership receive enhanced training including:
|
||||||
|
|
||||||
@@ -522,7 +522,7 @@ Management and leadership receive enhanced training including:
|
|||||||
|
|
||||||
**(h)** **Continuous Improvement**: Leadership in continuous improvement of compliance programmes.
|
**(h)** **Continuous Improvement**: Leadership in continuous improvement of compliance programmes.
|
||||||
|
|
||||||
### 7.3 Customer and Partner Education
|
### 7.3. Customer and Partner Education
|
||||||
|
|
||||||
We provide education and resources for customers and partners including:
|
We provide education and resources for customers and partners including:
|
||||||
|
|
||||||
@@ -542,7 +542,7 @@ We provide education and resources for customers and partners including:
|
|||||||
|
|
||||||
**(h)** **Documentation Support**: Support in developing compliance documentation and procedures.
|
**(h)** **Documentation Support**: Support in developing compliance documentation and procedures.
|
||||||
|
|
||||||
### 7.4 Awareness and Communication
|
### 7.4. Awareness and Communication
|
||||||
|
|
||||||
We maintain ongoing awareness and communication through:
|
We maintain ongoing awareness and communication through:
|
||||||
|
|
||||||
@@ -564,7 +564,7 @@ We maintain ongoing awareness and communication through:
|
|||||||
|
|
||||||
## 8. RECORD KEEPING AND DOCUMENTATION
|
## 8. RECORD KEEPING AND DOCUMENTATION
|
||||||
|
|
||||||
### 8.1 Documentation Requirements
|
### 8.1. Documentation Requirements
|
||||||
|
|
||||||
We maintain comprehensive documentation including:
|
We maintain comprehensive documentation including:
|
||||||
|
|
||||||
@@ -584,7 +584,7 @@ We maintain comprehensive documentation including:
|
|||||||
|
|
||||||
**(h)** **Violation Records**: Complete records of any violations and remedial actions taken.
|
**(h)** **Violation Records**: Complete records of any violations and remedial actions taken.
|
||||||
|
|
||||||
### 8.2 Retention Periods
|
### 8.2. Retention Periods
|
||||||
|
|
||||||
Documentation is retained according to the following schedule:
|
Documentation is retained according to the following schedule:
|
||||||
|
|
||||||
@@ -604,7 +604,7 @@ Documentation is retained according to the following schedule:
|
|||||||
|
|
||||||
**(h)** **Classification Records**: Classification determinations retained for life of technology or product.
|
**(h)** **Classification Records**: Classification determinations retained for life of technology or product.
|
||||||
|
|
||||||
### 8.3 Data Security and Access Controls
|
### 8.3. Data Security and Access Controls
|
||||||
|
|
||||||
Compliance documentation is protected through:
|
Compliance documentation is protected through:
|
||||||
|
|
||||||
@@ -624,7 +624,7 @@ Compliance documentation is protected through:
|
|||||||
|
|
||||||
**(h)** **Breach Response**: Incident response procedures for security breaches affecting compliance records.
|
**(h)** **Breach Response**: Incident response procedures for security breaches affecting compliance records.
|
||||||
|
|
||||||
### 8.4 Government Access and Cooperation
|
### 8.4. Government Access and Cooperation
|
||||||
|
|
||||||
We cooperate fully with government access requests through:
|
We cooperate fully with government access requests through:
|
||||||
|
|
||||||
@@ -646,7 +646,7 @@ We cooperate fully with government access requests through:
|
|||||||
|
|
||||||
## 9. INTERNATIONAL OPERATIONS AND SUBSIDIARIES
|
## 9. INTERNATIONAL OPERATIONS AND SUBSIDIARIES
|
||||||
|
|
||||||
### 9.1 Global Compliance Framework
|
### 9.1. Global Compliance Framework
|
||||||
|
|
||||||
Our international operations follow a unified compliance framework including:
|
Our international operations follow a unified compliance framework including:
|
||||||
|
|
||||||
@@ -666,7 +666,7 @@ Our international operations follow a unified compliance framework including:
|
|||||||
|
|
||||||
**(h)** **Regular Auditing**: Regular auditing of international compliance programmes and activities.
|
**(h)** **Regular Auditing**: Regular auditing of international compliance programmes and activities.
|
||||||
|
|
||||||
### 9.2 Regional Compliance Programmes
|
### 9.2. Regional Compliance Programmes
|
||||||
|
|
||||||
We maintain regional compliance programmes including:
|
We maintain regional compliance programmes including:
|
||||||
|
|
||||||
@@ -686,7 +686,7 @@ We maintain regional compliance programmes including:
|
|||||||
|
|
||||||
**(h)** **Cultural Adaptation**: Adaptation of compliance programmes to local cultural and business practices.
|
**(h)** **Cultural Adaptation**: Adaptation of compliance programmes to local cultural and business practices.
|
||||||
|
|
||||||
### 9.3 Cross-Border Data Flows
|
### 9.3. Cross-Border Data Flows
|
||||||
|
|
||||||
Management of cross-border data flows includes:
|
Management of cross-border data flows includes:
|
||||||
|
|
||||||
@@ -706,7 +706,7 @@ Management of cross-border data flows includes:
|
|||||||
|
|
||||||
**(h)** **Incident Response**: Incident response procedures for cross-border data incidents.
|
**(h)** **Incident Response**: Incident response procedures for cross-border data incidents.
|
||||||
|
|
||||||
### 9.4 Joint Ventures and Partnerships
|
### 9.4. Joint Ventures and Partnerships
|
||||||
|
|
||||||
For international joint ventures and partnerships:
|
For international joint ventures and partnerships:
|
||||||
|
|
||||||
@@ -728,7 +728,7 @@ For international joint ventures and partnerships:
|
|||||||
|
|
||||||
## 10. EMERGING TECHNOLOGIES AND FUTURE COMPLIANCE
|
## 10. EMERGING TECHNOLOGIES AND FUTURE COMPLIANCE
|
||||||
|
|
||||||
### 10.1 Emerging Technology Assessment
|
### 10.1. Emerging Technology Assessment
|
||||||
|
|
||||||
We proactively assess emerging technologies including:
|
We proactively assess emerging technologies including:
|
||||||
|
|
||||||
@@ -748,7 +748,7 @@ We proactively assess emerging technologies including:
|
|||||||
|
|
||||||
**(h)** **Space Technologies**: Export control implications of space and satellite technologies.
|
**(h)** **Space Technologies**: Export control implications of space and satellite technologies.
|
||||||
|
|
||||||
### 10.2 Regulatory Monitoring and Anticipation
|
### 10.2. Regulatory Monitoring and Anticipation
|
||||||
|
|
||||||
We actively monitor regulatory developments including:
|
We actively monitor regulatory developments including:
|
||||||
|
|
||||||
@@ -768,7 +768,7 @@ We actively monitor regulatory developments including:
|
|||||||
|
|
||||||
**(h)** **Government Engagement**: Active engagement with government authorities on regulatory development.
|
**(h)** **Government Engagement**: Active engagement with government authorities on regulatory development.
|
||||||
|
|
||||||
### 10.3 Adaptive Compliance Framework
|
### 10.3. Adaptive Compliance Framework
|
||||||
|
|
||||||
Our compliance framework adapts to changes through:
|
Our compliance framework adapts to changes through:
|
||||||
|
|
||||||
@@ -788,7 +788,7 @@ Our compliance framework adapts to changes through:
|
|||||||
|
|
||||||
**(h)** **Continuous Learning**: Continuous learning and improvement of compliance capabilities.
|
**(h)** **Continuous Learning**: Continuous learning and improvement of compliance capabilities.
|
||||||
|
|
||||||
### 10.4 Innovation and Compliance Balance
|
### 10.4. Innovation and Compliance Balance
|
||||||
|
|
||||||
We balance innovation with compliance through:
|
We balance innovation with compliance through:
|
||||||
|
|
||||||
@@ -810,7 +810,7 @@ We balance innovation with compliance through:
|
|||||||
|
|
||||||
## 11. CONTACT INFORMATION AND SUPPORT
|
## 11. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 11.1 Export Control and Sanctions Compliance
|
### 11.1. Export Control and Sanctions Compliance
|
||||||
|
|
||||||
For export control and sanctions compliance matters:
|
For export control and sanctions compliance matters:
|
||||||
|
|
||||||
@@ -822,7 +822,7 @@ For export control and sanctions compliance matters:
|
|||||||
|
|
||||||
**Emergency Contact:** Available for urgent compliance matters
|
**Emergency Contact:** Available for urgent compliance matters
|
||||||
|
|
||||||
### 11.2 License Applications and Government Relations
|
### 11.2. License Applications and Government Relations
|
||||||
|
|
||||||
For license applications and government relations:
|
For license applications and government relations:
|
||||||
|
|
||||||
@@ -834,7 +834,7 @@ For license applications and government relations:
|
|||||||
|
|
||||||
**Government Relations:** Dedicated team for government agency coordination
|
**Government Relations:** Dedicated team for government agency coordination
|
||||||
|
|
||||||
### 11.3 Sanctions Screening and Verification
|
### 11.3. Sanctions Screening and Verification
|
||||||
|
|
||||||
For sanctions screening and verification requests:
|
For sanctions screening and verification requests:
|
||||||
|
|
||||||
@@ -846,7 +846,7 @@ For sanctions screening and verification requests:
|
|||||||
|
|
||||||
**Automated Systems:** Real-time automated screening available through our systems
|
**Automated Systems:** Real-time automated screening available through our systems
|
||||||
|
|
||||||
### 11.4 Training and Education
|
### 11.4. Training and Education
|
||||||
|
|
||||||
For export control and sanctions training:
|
For export control and sanctions training:
|
||||||
|
|
||||||
@@ -858,14 +858,6 @@ For export control and sanctions training:
|
|||||||
|
|
||||||
**Response Time:** Within 3 business days for training requests
|
**Response Time:** Within 3 business days for training requests
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 March 2026
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Export Control and Sanctions Compliance Policy ensures our full compliance with international trade regulations whilst enabling lawful global service provision. By using our Services, you acknowledge understanding of these requirements and agree to comply with all applicable export control and sanctions laws. For compliance questions or assistance, please contact us at export-compliance@nhcarrigan.com.*
|
*This Export Control and Sanctions Compliance Policy ensures our full compliance with international trade regulations whilst enabling lawful global service provision. By using our Services, you acknowledge understanding of these requirements and agree to comply with all applicable export control and sanctions laws. For compliance questions or assistance, please contact us at export-compliance@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Government Actions and Compliance
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND POLICY STATEMENT
|
## 1. INTRODUCTION AND POLICY STATEMENT
|
||||||
|
|
||||||
### 1.1 Transparency Commitment
|
### 1.1. Transparency Commitment
|
||||||
|
|
||||||
This transparency report is published to maintain complete transparency regarding any actions taken by government agencies, law enforcement authorities, or other legal entities that may result in the disclosure of user data or information stored by nhcarrigan ("we," "us," "our," or "the Company").
|
This transparency report is published to maintain complete transparency regarding any actions taken by government agencies, law enforcement authorities, or other legal entities that may result in the disclosure of user data or information stored by NHCarrigan ("we," "us," "our," or "the Company").
|
||||||
|
|
||||||
### 1.2 Scope and Coverage
|
### 1.2. Scope and Coverage
|
||||||
|
|
||||||
This report covers:
|
This report covers:
|
||||||
|
|
||||||
@@ -20,9 +20,9 @@ This report covers:
|
|||||||
|
|
||||||
**(c)** Any asset seizures, data searches, or investigative actions affecting our systems or data;
|
**(c)** Any asset seizures, data searches, or investigative actions affecting our systems or data;
|
||||||
|
|
||||||
**(d)** All time periods from the inception of nhcarrigan operations to the date of this report.
|
**(d)** All time periods from the inception of NHCarrigan operations to the date of this report.
|
||||||
|
|
||||||
### 1.3 Reporting Principles
|
### 1.3. Reporting Principles
|
||||||
|
|
||||||
Our transparency reporting is guided by the following principles:
|
Our transparency reporting is guided by the following principles:
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ Our transparency reporting is guided by the following principles:
|
|||||||
|
|
||||||
## 2. POLICY DECLARATIONS
|
## 2. POLICY DECLARATIONS
|
||||||
|
|
||||||
### 2.1 Proactive Information Sharing
|
### 2.1. Proactive Information Sharing
|
||||||
|
|
||||||
We explicitly declare that:
|
We explicitly declare that:
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ We explicitly declare that:
|
|||||||
|
|
||||||
**(d)** All government data requests must follow proper legal channels and procedures.
|
**(d)** All government data requests must follow proper legal channels and procedures.
|
||||||
|
|
||||||
### 2.2 System Integrity and Access
|
### 2.2. System Integrity and Access
|
||||||
|
|
||||||
We firmly commit that:
|
We firmly commit that:
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ We firmly commit that:
|
|||||||
|
|
||||||
**(d)** Any access to user data by authorities must be pursuant to valid legal process and within the bounds of applicable law.
|
**(d)** Any access to user data by authorities must be pursuant to valid legal process and within the bounds of applicable law.
|
||||||
|
|
||||||
### 2.3 Legal Process Requirements
|
### 2.3. Legal Process Requirements
|
||||||
|
|
||||||
For any disclosure of user information, we require:
|
For any disclosure of user information, we require:
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ For any disclosure of user information, we require:
|
|||||||
|
|
||||||
**(d)** Compliance with applicable data protection and privacy laws.
|
**(d)** Compliance with applicable data protection and privacy laws.
|
||||||
|
|
||||||
### 2.4 User Notification Policy
|
### 2.4. User Notification Policy
|
||||||
|
|
||||||
Subject to legal restrictions and court orders:
|
Subject to legal restrictions and court orders:
|
||||||
|
|
||||||
@@ -86,13 +86,13 @@ Subject to legal restrictions and court orders:
|
|||||||
|
|
||||||
## 3. INFORMATION REQUESTS
|
## 3. INFORMATION REQUESTS
|
||||||
|
|
||||||
### 3.1 Summary Statistics
|
### 3.1. Summary Statistics
|
||||||
|
|
||||||
**Total Requests Received:** 0 (Zero)
|
**Total Requests Received:** 0 (Zero)
|
||||||
|
|
||||||
**Time Period Covered:** From inception of nhcarrigan operations through the date of this report
|
**Time Period Covered:** From inception of NHCarrigan operations through the date of this report
|
||||||
|
|
||||||
### 3.2 Types of Information Requests
|
### 3.2. Types of Information Requests
|
||||||
|
|
||||||
We categorise information requests as follows:
|
We categorise information requests as follows:
|
||||||
|
|
||||||
@@ -104,13 +104,13 @@ We categorise information requests as follows:
|
|||||||
|
|
||||||
**(d)** **Regulatory Inquiries:** From regulatory bodies regarding compliance or oversight.
|
**(d)** **Regulatory Inquiries:** From regulatory bodies regarding compliance or oversight.
|
||||||
|
|
||||||
### 3.3 Detailed Request Log
|
### 3.3. Detailed Request Log
|
||||||
|
|
||||||
| Request Date | Agency/Authority | Type of Request | Information Requested | Legal Basis | Response Date | Result/Action Taken | User Notification |
|
| Request Date | Agency/Authority | Type of Request | Information Requested | Legal Basis | Response Date | Result/Action Taken | User Notification |
|
||||||
|--------------|------------------|-----------------|----------------------|-------------|---------------|---------------------|-------------------|
|
|--------------|------------------|-----------------|----------------------|-------------|---------------|---------------------|-------------------|
|
||||||
| No requests received to date | | | | | | | |
|
| No requests received to date | | | | | | | |
|
||||||
|
|
||||||
### 3.4 Response Procedures
|
### 3.4. Response Procedures
|
||||||
|
|
||||||
When we receive information requests, our standard procedure includes:
|
When we receive information requests, our standard procedure includes:
|
||||||
|
|
||||||
@@ -124,15 +124,15 @@ When we receive information requests, our standard procedure includes:
|
|||||||
|
|
||||||
## 4. WARRANTS AND SUBPOENAS
|
## 4. WARRANTS AND SUBPOENAS
|
||||||
|
|
||||||
### 4.1 Summary Statistics
|
### 4.1. Summary Statistics
|
||||||
|
|
||||||
**Total Warrants Received:** 0 (Zero)
|
**Total Warrants Received:** 0 (Zero)
|
||||||
|
|
||||||
**Total Subpoenas Received:** 0 (Zero)
|
**Total Subpoenas Received:** 0 (Zero)
|
||||||
|
|
||||||
**Time Period Covered:** From inception of nhcarrigan operations through the date of this report
|
**Time Period Covered:** From inception of NHCarrigan operations through the date of this report
|
||||||
|
|
||||||
### 4.2 Types of Legal Process
|
### 4.2. Types of Legal Process
|
||||||
|
|
||||||
We track the following types of legal process:
|
We track the following types of legal process:
|
||||||
|
|
||||||
@@ -144,13 +144,13 @@ We track the following types of legal process:
|
|||||||
|
|
||||||
**(d)** **National Security Letters:** Administrative subpoenas related to national security investigations (where applicable).
|
**(d)** **National Security Letters:** Administrative subpoenas related to national security investigations (where applicable).
|
||||||
|
|
||||||
### 4.3 Detailed Process Log
|
### 4.3. Detailed Process Log
|
||||||
|
|
||||||
| Service Date | Court/Agency | Type of Process | Scope of Request | Response Required | Response Date | Compliance Action | Challenge Filed | User Notification |
|
| Service Date | Court/Agency | Type of Process | Scope of Request | Response Required | Response Date | Compliance Action | Challenge Filed | User Notification |
|
||||||
|--------------|--------------|-----------------|------------------|-------------------|---------------|-------------------|-----------------|-------------------|
|
|--------------|--------------|-----------------|------------------|-------------------|---------------|-------------------|-----------------|-------------------|
|
||||||
| No legal process served to date | | | | | | | | |
|
| No legal process served to date | | | | | | | | |
|
||||||
|
|
||||||
### 4.4 Legal Challenge Policy
|
### 4.4. Legal Challenge Policy
|
||||||
|
|
||||||
Our policy regarding legal challenges includes:
|
Our policy regarding legal challenges includes:
|
||||||
|
|
||||||
@@ -164,13 +164,13 @@ Our policy regarding legal challenges includes:
|
|||||||
|
|
||||||
## 5. ASSET SEIZURES AND SEARCHES
|
## 5. ASSET SEIZURES AND SEARCHES
|
||||||
|
|
||||||
### 5.1 Summary Statistics
|
### 5.1. Summary Statistics
|
||||||
|
|
||||||
**Total Seizures/Searches:** 0 (Zero)
|
**Total Seizures/Searches:** 0 (Zero)
|
||||||
|
|
||||||
**Time Period Covered:** From inception of nhcarrigan operations through the date of this report
|
**Time Period Covered:** From inception of NHCarrigan operations through the date of this report
|
||||||
|
|
||||||
### 5.2 Types of Seizures and Searches
|
### 5.2. Types of Seizures and Searches
|
||||||
|
|
||||||
We categorise enforcement actions as follows:
|
We categorise enforcement actions as follows:
|
||||||
|
|
||||||
@@ -182,13 +182,13 @@ We categorise enforcement actions as follows:
|
|||||||
|
|
||||||
**(d)** **Data Preservation:** Requirements to preserve specific data pending legal proceedings.
|
**(d)** **Data Preservation:** Requirements to preserve specific data pending legal proceedings.
|
||||||
|
|
||||||
### 5.3 Detailed Action Log
|
### 5.3. Detailed Action Log
|
||||||
|
|
||||||
| Action Date | Agency | Type of Action | Scope of Search/Seizure | Legal Authority | Property/Data Affected | Recovery/Return | Impact Assessment |
|
| Action Date | Agency | Type of Action | Scope of Search/Seizure | Legal Authority | Property/Data Affected | Recovery/Return | Impact Assessment |
|
||||||
|-------------|--------|----------------|-------------------------|-----------------|------------------------|-----------------|-------------------|
|
|-------------|--------|----------------|-------------------------|-----------------|------------------------|-----------------|-------------------|
|
||||||
| No seizures or searches to date | | | | | | | |
|
| No seizures or searches to date | | | | | | | |
|
||||||
|
|
||||||
### 5.4 Response and Mitigation Procedures
|
### 5.4. Response and Mitigation Procedures
|
||||||
|
|
||||||
In the event of asset seizures or searches, our procedures include:
|
In the event of asset seizures or searches, our procedures include:
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ In the event of asset seizures or searches, our procedures include:
|
|||||||
|
|
||||||
## 6. DATA PROTECTION AND PRIVACY SAFEGUARDS
|
## 6. DATA PROTECTION AND PRIVACY SAFEGUARDS
|
||||||
|
|
||||||
### 6.1 Technical Safeguards
|
### 6.1. Technical Safeguards
|
||||||
|
|
||||||
We implement technical measures to protect user data:
|
We implement technical measures to protect user data:
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ We implement technical measures to protect user data:
|
|||||||
|
|
||||||
**(d)** **Data Minimisation:** Collection and retention of only necessary user information.
|
**(d)** **Data Minimisation:** Collection and retention of only necessary user information.
|
||||||
|
|
||||||
### 6.2 Legal Safeguards
|
### 6.2. Legal Safeguards
|
||||||
|
|
||||||
Our legal protections include:
|
Our legal protections include:
|
||||||
|
|
||||||
@@ -226,7 +226,7 @@ Our legal protections include:
|
|||||||
|
|
||||||
**(d)** **Jurisdictional Analysis:** Careful analysis of jurisdictional issues in cross-border requests.
|
**(d)** **Jurisdictional Analysis:** Careful analysis of jurisdictional issues in cross-border requests.
|
||||||
|
|
||||||
### 6.3 Operational Safeguards
|
### 6.3. Operational Safeguards
|
||||||
|
|
||||||
Our operational procedures include:
|
Our operational procedures include:
|
||||||
|
|
||||||
@@ -238,7 +238,7 @@ Our operational procedures include:
|
|||||||
|
|
||||||
**(d)** **Recovery Procedures:** Plans for service recovery following any enforcement actions.
|
**(d)** **Recovery Procedures:** Plans for service recovery following any enforcement actions.
|
||||||
|
|
||||||
### 6.4 International Considerations
|
### 6.4. International Considerations
|
||||||
|
|
||||||
For cross-border requests, we consider:
|
For cross-border requests, we consider:
|
||||||
|
|
||||||
@@ -252,7 +252,7 @@ For cross-border requests, we consider:
|
|||||||
|
|
||||||
## 7. REPORTING METHODOLOGY AND LIMITATIONS
|
## 7. REPORTING METHODOLOGY AND LIMITATIONS
|
||||||
|
|
||||||
### 7.1 Data Collection
|
### 7.1. Data Collection
|
||||||
|
|
||||||
This transparency report is compiled using:
|
This transparency report is compiled using:
|
||||||
|
|
||||||
@@ -264,7 +264,7 @@ This transparency report is compiled using:
|
|||||||
|
|
||||||
**(d)** **Legal Review:** Quarterly review by qualified legal counsel for completeness and accuracy.
|
**(d)** **Legal Review:** Quarterly review by qualified legal counsel for completeness and accuracy.
|
||||||
|
|
||||||
### 7.2 Reporting Limitations
|
### 7.2. Reporting Limitations
|
||||||
|
|
||||||
This report is subject to the following limitations:
|
This report is subject to the following limitations:
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ This report is subject to the following limitations:
|
|||||||
|
|
||||||
**(d)** **Aggregation Requirements:** Some jurisdictions may require statistical aggregation rather than detailed reporting.
|
**(d)** **Aggregation Requirements:** Some jurisdictions may require statistical aggregation rather than detailed reporting.
|
||||||
|
|
||||||
### 7.3 Update Schedule
|
### 7.3. Update Schedule
|
||||||
|
|
||||||
This report is updated according to the following schedule:
|
This report is updated according to the following schedule:
|
||||||
|
|
||||||
@@ -288,7 +288,7 @@ This report is updated according to the following schedule:
|
|||||||
|
|
||||||
**(d)** **Legal Milestone Updates:** Updates following resolution of significant legal matters.
|
**(d)** **Legal Milestone Updates:** Updates following resolution of significant legal matters.
|
||||||
|
|
||||||
### 7.4 Verification and Accuracy
|
### 7.4. Verification and Accuracy
|
||||||
|
|
||||||
We ensure report accuracy through:
|
We ensure report accuracy through:
|
||||||
|
|
||||||
@@ -302,7 +302,7 @@ We ensure report accuracy through:
|
|||||||
|
|
||||||
## 8. CONTACT INFORMATION AND SUPPORT
|
## 8. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 8.1 Legal Process Service
|
### 8.1. Legal Process Service
|
||||||
|
|
||||||
For service of legal process:
|
For service of legal process:
|
||||||
|
|
||||||
@@ -312,7 +312,7 @@ For service of legal process:
|
|||||||
|
|
||||||
**Business Hours:** Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time
|
**Business Hours:** Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time
|
||||||
|
|
||||||
### 8.2 General Inquiries
|
### 8.2. General Inquiries
|
||||||
|
|
||||||
For questions about this transparency report:
|
For questions about this transparency report:
|
||||||
|
|
||||||
@@ -320,7 +320,7 @@ For questions about this transparency report:
|
|||||||
|
|
||||||
**Subject Line:** Government Transparency Report Inquiry
|
**Subject Line:** Government Transparency Report Inquiry
|
||||||
|
|
||||||
### 8.3 Media and Press Inquiries
|
### 8.3. Media and Press Inquiries
|
||||||
|
|
||||||
For media inquiries regarding government actions:
|
For media inquiries regarding government actions:
|
||||||
|
|
||||||
@@ -328,19 +328,19 @@ For media inquiries regarding government actions:
|
|||||||
|
|
||||||
**Response Time:** Within 24 hours for urgent matters
|
**Response Time:** Within 24 hours for urgent matters
|
||||||
|
|
||||||
### 8.4 User Support
|
### 8.4. User Support
|
||||||
|
|
||||||
For users concerned about government access to their data:
|
For users concerned about government access to their data:
|
||||||
|
|
||||||
**Email:** privacy@nhcarrigan.com
|
**Email:** privacy@nhcarrigan.com
|
||||||
|
|
||||||
**Forum:** https://forum.nhcarrigan.com
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Response Time:** Within 48 hours for privacy-related inquiries
|
**Response Time:** Within 48 hours for privacy-related inquiries
|
||||||
|
|
||||||
## 9. FUTURE DEVELOPMENTS
|
## 9. FUTURE DEVELOPMENTS
|
||||||
|
|
||||||
### 9.1 Policy Evolution
|
### 9.1. Policy Evolution
|
||||||
|
|
||||||
We continuously review and improve our government transparency policies based on:
|
We continuously review and improve our government transparency policies based on:
|
||||||
|
|
||||||
@@ -352,7 +352,7 @@ We continuously review and improve our government transparency policies based on
|
|||||||
|
|
||||||
**(d)** **Operational Experience:** Lessons learned from any government interactions.
|
**(d)** **Operational Experience:** Lessons learned from any government interactions.
|
||||||
|
|
||||||
### 9.2 Enhanced Reporting
|
### 9.2. Enhanced Reporting
|
||||||
|
|
||||||
We are committed to enhancing this transparency report through:
|
We are committed to enhancing this transparency report through:
|
||||||
|
|
||||||
@@ -364,7 +364,7 @@ We are committed to enhancing this transparency report through:
|
|||||||
|
|
||||||
**(d)** **International Perspective:** Expanding coverage to include international legal developments.
|
**(d)** **International Perspective:** Expanding coverage to include international legal developments.
|
||||||
|
|
||||||
### 9.3 Stakeholder Engagement
|
### 9.3. Stakeholder Engagement
|
||||||
|
|
||||||
We engage with stakeholders through:
|
We engage with stakeholders through:
|
||||||
|
|
||||||
@@ -378,7 +378,7 @@ We engage with stakeholders through:
|
|||||||
|
|
||||||
## 10. LEGAL DISCLAIMER
|
## 10. LEGAL DISCLAIMER
|
||||||
|
|
||||||
### 10.1 Report Limitations
|
### 10.1. Report Limitations
|
||||||
|
|
||||||
This transparency report:
|
This transparency report:
|
||||||
|
|
||||||
@@ -390,7 +390,7 @@ This transparency report:
|
|||||||
|
|
||||||
**(d)** Represents our good faith effort to provide accurate and complete information.
|
**(d)** Represents our good faith effort to provide accurate and complete information.
|
||||||
|
|
||||||
### 10.2 Legal Compliance
|
### 10.2. Legal Compliance
|
||||||
|
|
||||||
This report is prepared in compliance with:
|
This report is prepared in compliance with:
|
||||||
|
|
||||||
@@ -402,7 +402,7 @@ This report is prepared in compliance with:
|
|||||||
|
|
||||||
**(d)** National security and law enforcement confidentiality requirements.
|
**(d)** National security and law enforcement confidentiality requirements.
|
||||||
|
|
||||||
### 10.3 No Warranties
|
### 10.3. No Warranties
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive warranty disclaimers and liability limitations applicable to this report and all our services are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
**IMPORTANT: Comprehensive warranty disclaimers and liability limitations applicable to this report and all our services are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
@@ -414,11 +414,11 @@ In addition to those comprehensive protections, this transparency report is prov
|
|||||||
|
|
||||||
**(c)** Changes in circumstances after publication date.
|
**(c)** Changes in circumstances after publication date.
|
||||||
|
|
||||||
**Report Period:** From inception of nhcarrigan operations through [Date to be inserted]
|
**Report Period:** From inception of NHCarrigan operations through
|
||||||
|
|
||||||
**Publication Date:** [Date to be inserted]
|
**Publication Date:**
|
||||||
|
|
||||||
**Next Scheduled Update:** [Date to be inserted]
|
**Next Scheduled Update:**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Limitation of Liability and Indemnification Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Purpose and Importance
|
### 1.1. Policy Purpose and Importance
|
||||||
|
|
||||||
This Limitation of Liability and Indemnification Policy ("Policy") establishes comprehensive protections for nhcarrigan ("we," "us," "our," or "the Company") and clarifies the allocation of risk and responsibility between the Company and users of our services, applications, and platforms (collectively, the "Services"). This Policy is fundamental to our ability to provide innovative services whilst managing legal and financial risks.
|
This Limitation of Liability and Indemnification Policy ("Policy") establishes comprehensive protections for NHCarrigan ("we," "us," "our," or "the Company") and clarifies the allocation of risk and responsibility between the Company and users of our services, applications, and platforms (collectively, the "Services"). This Policy is fundamental to our ability to provide innovative services whilst managing legal and financial risks.
|
||||||
|
|
||||||
### 1.2 Integration with Other Legal Documents
|
### 1.2. Integration with Other Legal Documents
|
||||||
|
|
||||||
This Policy operates in conjunction with and supplements:
|
This Policy operates in conjunction with and supplements:
|
||||||
|
|
||||||
@@ -28,13 +28,13 @@ This Policy operates in conjunction with and supplements:
|
|||||||
|
|
||||||
Where conflicts exist between documents, the most restrictive liability limitation shall apply to ensure maximum protection for the Company.
|
Where conflicts exist between documents, the most restrictive liability limitation shall apply to ensure maximum protection for the Company.
|
||||||
|
|
||||||
### 1.3 Scope of Application
|
### 1.3. Scope of Application
|
||||||
|
|
||||||
This Policy applies to:
|
This Policy applies to:
|
||||||
|
|
||||||
**(a)** All users, customers, developers, and third parties interacting with our Services;
|
**(a)** All users, customers, developers, and third parties interacting with our Services;
|
||||||
|
|
||||||
**(b)** All services, applications, platforms, and tools provided by nhcarrigan;
|
**(b)** All services, applications, platforms, and tools provided by NHCarrigan;
|
||||||
|
|
||||||
**(c)** All content, data, and information processed through our Services;
|
**(c)** All content, data, and information processed through our Services;
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ This Policy applies to:
|
|||||||
|
|
||||||
**(h)** All jurisdictions where our Services are accessed or used.
|
**(h)** All jurisdictions where our Services are accessed or used.
|
||||||
|
|
||||||
### 1.4 Legal Framework and Enforceability
|
### 1.4. Legal Framework and Enforceability
|
||||||
|
|
||||||
This Policy is designed to:
|
This Policy is designed to:
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ This Policy is designed to:
|
|||||||
|
|
||||||
## 2. COMPREHENSIVE LIABILITY DISCLAIMERS
|
## 2. COMPREHENSIVE LIABILITY DISCLAIMERS
|
||||||
|
|
||||||
### 2.1 General Service Disclaimers
|
### 2.1. General Service Disclaimers
|
||||||
|
|
||||||
**IMPORTANT NOTICE: THE FOLLOWING DISCLAIMERS ARE FUNDAMENTAL TO OUR SERVICE RELATIONSHIP AND CONSTITUTE ESSENTIAL TERMS OF YOUR AGREEMENT WITH US.**
|
**IMPORTANT NOTICE: THE FOLLOWING DISCLAIMERS ARE FUNDAMENTAL TO OUR SERVICE RELATIONSHIP AND CONSTITUTE ESSENTIAL TERMS OF YOUR AGREEMENT WITH US.**
|
||||||
|
|
||||||
@@ -98,7 +98,7 @@ We expressly disclaim and exclude all warranties including, but not limited to:
|
|||||||
|
|
||||||
**(h)** **Security**: No warranty that Services will be secure or that data will be protected from unauthorised access.
|
**(h)** **Security**: No warranty that Services will be secure or that data will be protected from unauthorised access.
|
||||||
|
|
||||||
### 2.2 Technology and Software Disclaimers
|
### 2.2. Technology and Software Disclaimers
|
||||||
|
|
||||||
Regarding our technology, software, and digital services:
|
Regarding our technology, software, and digital services:
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Regarding our technology, software, and digital services:
|
|||||||
|
|
||||||
**(h)** **Scalability**: No warranty regarding scalability or ability to handle increased usage demands.
|
**(h)** **Scalability**: No warranty regarding scalability or ability to handle increased usage demands.
|
||||||
|
|
||||||
### 2.3 Content and Information Disclaimers
|
### 2.3. Content and Information Disclaimers
|
||||||
|
|
||||||
Regarding content and information provided through our Services:
|
Regarding content and information provided through our Services:
|
||||||
|
|
||||||
@@ -138,7 +138,7 @@ Regarding content and information provided through our Services:
|
|||||||
|
|
||||||
**(h)** **Verification**: No obligation to verify the accuracy or completeness of any content or information.
|
**(h)** **Verification**: No obligation to verify the accuracy or completeness of any content or information.
|
||||||
|
|
||||||
### 2.4 Business and Commercial Disclaimers
|
### 2.4. Business and Commercial Disclaimers
|
||||||
|
|
||||||
For business and commercial use of our Services:
|
For business and commercial use of our Services:
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 3. COMPREHENSIVE LIMITATION OF LIABILITY
|
## 3. COMPREHENSIVE LIMITATION OF LIABILITY
|
||||||
|
|
||||||
### 3.1 Exclusion of Consequential and Indirect Damages
|
### 3.1. Exclusion of Consequential and Indirect Damages
|
||||||
|
|
||||||
**TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, NHCARRIGAN SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, PUNITIVE, OR EXEMPLARY DAMAGES, INCLUDING BUT NOT LIMITED TO:**
|
**TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, NHCARRIGAN SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, PUNITIVE, OR EXEMPLARY DAMAGES, INCLUDING BUT NOT LIMITED TO:**
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Personal Injury**: Personal injury, emotional distress, or mental anguish (except where prohibited by law).
|
**(h)** **Personal Injury**: Personal injury, emotional distress, or mental anguish (except where prohibited by law).
|
||||||
|
|
||||||
### 3.2 Exclusion of Direct Damages
|
### 3.2. Exclusion of Direct Damages
|
||||||
|
|
||||||
**TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, WE ALSO DISCLAIM LIABILITY FOR DIRECT DAMAGES INCLUDING:**
|
**TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, WE ALSO DISCLAIM LIABILITY FOR DIRECT DAMAGES INCLUDING:**
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Force Majeure**: Damages from events beyond our reasonable control.
|
**(h)** **Force Majeure**: Damages from events beyond our reasonable control.
|
||||||
|
|
||||||
### 3.3 Maximum Liability Cap
|
### 3.3. Maximum Liability Cap
|
||||||
|
|
||||||
**IN JURISDICTIONS THAT DO NOT PERMIT COMPLETE EXCLUSION OF LIABILITY:**
|
**IN JURISDICTIONS THAT DO NOT PERMIT COMPLETE EXCLUSION OF LIABILITY:**
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Currency Conversion**: All monetary limits are stated in United States Dollars with conversion at current exchange rates.
|
**(h)** **Currency Conversion**: All monetary limits are stated in United States Dollars with conversion at current exchange rates.
|
||||||
|
|
||||||
### 3.4 Liability Limitation Scope
|
### 3.4. Liability Limitation Scope
|
||||||
|
|
||||||
**These liability limitations apply regardless of:**
|
**These liability limitations apply regardless of:**
|
||||||
|
|
||||||
@@ -242,9 +242,9 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 4. COMPREHENSIVE INDEMNIFICATION PROVISIONS
|
## 4. COMPREHENSIVE INDEMNIFICATION PROVISIONS
|
||||||
|
|
||||||
### 4.1 User Indemnification Obligations
|
### 4.1. User Indemnification Obligations
|
||||||
|
|
||||||
**Users agree to indemnify, defend, and hold harmless nhcarrigan, its parent companies, subsidiaries, affiliates, officers, directors, employees, agents, contractors, licensors, and service providers (collectively, the "Indemnified Parties") from and against any and all claims, demands, actions, damages, losses, costs, liabilities, and expenses (including reasonable attorneys' fees and court costs) arising from or relating to:**
|
**Users agree to indemnify, defend, and hold harmless NHCarrigan, its parent companies, subsidiaries, affiliates, officers, directors, employees, agents, contractors, licensors, and service providers (collectively, the "Indemnified Parties") from and against any and all claims, demands, actions, damages, losses, costs, liabilities, and expenses (including reasonable attorneys' fees and court costs) arising from or relating to:**
|
||||||
|
|
||||||
**(a)** **Service Usage**: Your use, misuse, or inability to use the Services in any manner;
|
**(a)** **Service Usage**: Your use, misuse, or inability to use the Services in any manner;
|
||||||
|
|
||||||
@@ -262,7 +262,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Downstream Usage**: Any use of Services by third parties through your account or authorisation.
|
**(h)** **Downstream Usage**: Any use of Services by third parties through your account or authorisation.
|
||||||
|
|
||||||
### 4.2 Commercial and Business Indemnification
|
### 4.2. Commercial and Business Indemnification
|
||||||
|
|
||||||
**For commercial and business users, indemnification extends to:**
|
**For commercial and business users, indemnification extends to:**
|
||||||
|
|
||||||
@@ -282,7 +282,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Licensing Violations**: Claims from violation of software licences or intellectual property rights.
|
**(h)** **Licensing Violations**: Claims from violation of software licences or intellectual property rights.
|
||||||
|
|
||||||
### 4.3 Developer and API Indemnification
|
### 4.3. Developer and API Indemnification
|
||||||
|
|
||||||
**Developers and API users agree to additional indemnification for:**
|
**Developers and API users agree to additional indemnification for:**
|
||||||
|
|
||||||
@@ -302,7 +302,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Compliance Failures**: Claims from failure to comply with API terms or usage restrictions.
|
**(h)** **Compliance Failures**: Claims from failure to comply with API terms or usage restrictions.
|
||||||
|
|
||||||
### 4.4 Indemnification Process and Procedures
|
### 4.4. Indemnification Process and Procedures
|
||||||
|
|
||||||
**The indemnification process includes:**
|
**The indemnification process includes:**
|
||||||
|
|
||||||
@@ -324,7 +324,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 5. RISK ALLOCATION AND USER RESPONSIBILITY
|
## 5. RISK ALLOCATION AND USER RESPONSIBILITY
|
||||||
|
|
||||||
### 5.1 User Assumption of Risk
|
### 5.1. User Assumption of Risk
|
||||||
|
|
||||||
**By using our Services, users expressly acknowledge and assume the following risks:**
|
**By using our Services, users expressly acknowledge and assume the following risks:**
|
||||||
|
|
||||||
@@ -344,7 +344,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Market Risks**: Risks of market changes, competitive pressures, or business model evolution.
|
**(h)** **Market Risks**: Risks of market changes, competitive pressures, or business model evolution.
|
||||||
|
|
||||||
### 5.2 User Responsibility for Risk Management
|
### 5.2. User Responsibility for Risk Management
|
||||||
|
|
||||||
**Users are solely responsible for:**
|
**Users are solely responsible for:**
|
||||||
|
|
||||||
@@ -364,7 +364,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Contingency Planning**: Developing contingency plans for service interruptions or failures.
|
**(h)** **Contingency Planning**: Developing contingency plans for service interruptions or failures.
|
||||||
|
|
||||||
### 5.3 Company Risk Management Limitations
|
### 5.3. Company Risk Management Limitations
|
||||||
|
|
||||||
**Our risk management efforts are limited to:**
|
**Our risk management efforts are limited to:**
|
||||||
|
|
||||||
@@ -384,7 +384,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Continuous Improvement**: Continuously improving our services and risk management practices.
|
**(h)** **Continuous Improvement**: Continuously improving our services and risk management practices.
|
||||||
|
|
||||||
### 5.4 Shared Responsibility Model
|
### 5.4. Shared Responsibility Model
|
||||||
|
|
||||||
**Our service relationship operates under a shared responsibility model:**
|
**Our service relationship operates under a shared responsibility model:**
|
||||||
|
|
||||||
@@ -402,7 +402,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 6. FORCE MAJEURE AND EXTERNAL FACTORS
|
## 6. FORCE MAJEURE AND EXTERNAL FACTORS
|
||||||
|
|
||||||
### 6.1 Force Majeure Events
|
### 6.1. Force Majeure Events
|
||||||
|
|
||||||
**We shall not be liable for any failure to perform or delay in performance due to force majeure events, including but not limited to:**
|
**We shall not be liable for any failure to perform or delay in performance due to force majeure events, including but not limited to:**
|
||||||
|
|
||||||
@@ -422,7 +422,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Regulatory Changes**: Sudden regulatory changes that materially affect our ability to provide Services.
|
**(h)** **Regulatory Changes**: Sudden regulatory changes that materially affect our ability to provide Services.
|
||||||
|
|
||||||
### 6.2 Third-Party Dependencies
|
### 6.2. Third-Party Dependencies
|
||||||
|
|
||||||
**Our Services rely on various third-party providers and dependencies, and we disclaim liability for:**
|
**Our Services rely on various third-party providers and dependencies, and we disclaim liability for:**
|
||||||
|
|
||||||
@@ -442,7 +442,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Regulatory Authorities**: Actions by regulatory authorities that affect third-party service provision.
|
**(h)** **Regulatory Authorities**: Actions by regulatory authorities that affect third-party service provision.
|
||||||
|
|
||||||
### 6.3 Technology Limitations
|
### 6.3. Technology Limitations
|
||||||
|
|
||||||
**We disclaim liability for limitations inherent in technology:**
|
**We disclaim liability for limitations inherent in technology:**
|
||||||
|
|
||||||
@@ -464,7 +464,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 7. JURISDICTIONAL VARIATIONS AND ENFORCEABILITY
|
## 7. JURISDICTIONAL VARIATIONS AND ENFORCEABILITY
|
||||||
|
|
||||||
### 7.1 Jurisdictional Adaptation
|
### 7.1. Jurisdictional Adaptation
|
||||||
|
|
||||||
**These liability limitations are designed to be enforceable across jurisdictions:**
|
**These liability limitations are designed to be enforceable across jurisdictions:**
|
||||||
|
|
||||||
@@ -484,7 +484,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Conflict of Laws**: Clear conflict of law provisions to determine applicable liability rules.
|
**(h)** **Conflict of Laws**: Clear conflict of law provisions to determine applicable liability rules.
|
||||||
|
|
||||||
### 7.2 Consumer Protection Considerations
|
### 7.2. Consumer Protection Considerations
|
||||||
|
|
||||||
**In jurisdictions with consumer protection laws:**
|
**In jurisdictions with consumer protection laws:**
|
||||||
|
|
||||||
@@ -504,7 +504,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Regulatory Compliance**: Compliance with consumer protection regulations and guidance.
|
**(h)** **Regulatory Compliance**: Compliance with consumer protection regulations and guidance.
|
||||||
|
|
||||||
### 7.3 Business and Commercial Enforceability
|
### 7.3. Business and Commercial Enforceability
|
||||||
|
|
||||||
**For business and commercial relationships:**
|
**For business and commercial relationships:**
|
||||||
|
|
||||||
@@ -524,7 +524,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Professional Standards**: Compliance with professional standards and best practices.
|
**(h)** **Professional Standards**: Compliance with professional standards and best practices.
|
||||||
|
|
||||||
### 7.4 International Enforcement
|
### 7.4. International Enforcement
|
||||||
|
|
||||||
**For international service provision:**
|
**For international service provision:**
|
||||||
|
|
||||||
@@ -546,7 +546,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 8. INSURANCE AND RISK TRANSFER
|
## 8. INSURANCE AND RISK TRANSFER
|
||||||
|
|
||||||
### 8.1 User Insurance Recommendations
|
### 8.1. User Insurance Recommendations
|
||||||
|
|
||||||
**We strongly recommend that users maintain:**
|
**We strongly recommend that users maintain:**
|
||||||
|
|
||||||
@@ -566,7 +566,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Industry-Specific**: Industry-specific insurance coverage for regulated sectors.
|
**(h)** **Industry-Specific**: Industry-specific insurance coverage for regulated sectors.
|
||||||
|
|
||||||
### 8.2 Risk Transfer Mechanisms
|
### 8.2. Risk Transfer Mechanisms
|
||||||
|
|
||||||
**Our liability limitations facilitate risk transfer through:**
|
**Our liability limitations facilitate risk transfer through:**
|
||||||
|
|
||||||
@@ -586,7 +586,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Risk Sharing**: Enabling risk sharing arrangements between commercial parties.
|
**(h)** **Risk Sharing**: Enabling risk sharing arrangements between commercial parties.
|
||||||
|
|
||||||
### 8.3 Insurance Coordination
|
### 8.3. Insurance Coordination
|
||||||
|
|
||||||
**These liability limitations coordinate with insurance coverage through:**
|
**These liability limitations coordinate with insurance coverage through:**
|
||||||
|
|
||||||
@@ -608,7 +608,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 9. SURVIVAL AND ENFORCEMENT
|
## 9. SURVIVAL AND ENFORCEMENT
|
||||||
|
|
||||||
### 9.1 Survival of Provisions
|
### 9.1. Survival of Provisions
|
||||||
|
|
||||||
**The following provisions survive termination of any agreement or relationship:**
|
**The following provisions survive termination of any agreement or relationship:**
|
||||||
|
|
||||||
@@ -628,7 +628,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Governing Law**: Governing law and jurisdiction provisions continue to apply to all matters.
|
**(h)** **Governing Law**: Governing law and jurisdiction provisions continue to apply to all matters.
|
||||||
|
|
||||||
### 9.2 Enforcement Mechanisms
|
### 9.2. Enforcement Mechanisms
|
||||||
|
|
||||||
**These limitations are enforceable through:**
|
**These limitations are enforceable through:**
|
||||||
|
|
||||||
@@ -648,7 +648,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **Compliance Monitoring**: Ongoing monitoring of compliance with limitation requirements.
|
**(h)** **Compliance Monitoring**: Ongoing monitoring of compliance with limitation requirements.
|
||||||
|
|
||||||
### 9.3 Amendment and Modification
|
### 9.3. Amendment and Modification
|
||||||
|
|
||||||
**These liability limitations may be amended only through:**
|
**These liability limitations may be amended only through:**
|
||||||
|
|
||||||
@@ -668,7 +668,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
**(h)** **User Notice**: Appropriate notice to users of any changes affecting their obligations or rights.
|
**(h)** **User Notice**: Appropriate notice to users of any changes affecting their obligations or rights.
|
||||||
|
|
||||||
### 9.4 Integration and Interpretation
|
### 9.4. Integration and Interpretation
|
||||||
|
|
||||||
**These provisions shall be interpreted and applied as follows:**
|
**These provisions shall be interpreted and applied as follows:**
|
||||||
|
|
||||||
@@ -690,7 +690,7 @@ For business and commercial use of our Services:
|
|||||||
|
|
||||||
## 10. CONTACT INFORMATION AND LEGAL SUPPORT
|
## 10. CONTACT INFORMATION AND LEGAL SUPPORT
|
||||||
|
|
||||||
### 10.1 Legal and Liability Questions
|
### 10.1. Legal and Liability Questions
|
||||||
|
|
||||||
For questions about liability limitations and legal matters:
|
For questions about liability limitations and legal matters:
|
||||||
|
|
||||||
@@ -702,7 +702,7 @@ For questions about liability limitations and legal matters:
|
|||||||
|
|
||||||
**Legal Counsel:** All complex legal matters are reviewed by qualified legal counsel
|
**Legal Counsel:** All complex legal matters are reviewed by qualified legal counsel
|
||||||
|
|
||||||
### 10.2 Claims and Disputes
|
### 10.2. Claims and Disputes
|
||||||
|
|
||||||
For claims potentially subject to liability limitations:
|
For claims potentially subject to liability limitations:
|
||||||
|
|
||||||
@@ -714,7 +714,7 @@ For claims potentially subject to liability limitations:
|
|||||||
|
|
||||||
**Response Time:** Within 10 business days for claim acknowledgement
|
**Response Time:** Within 10 business days for claim acknowledgement
|
||||||
|
|
||||||
### 10.3 Insurance and Risk Management
|
### 10.3. Insurance and Risk Management
|
||||||
|
|
||||||
For insurance and risk management coordination:
|
For insurance and risk management coordination:
|
||||||
|
|
||||||
@@ -726,7 +726,7 @@ For insurance and risk management coordination:
|
|||||||
|
|
||||||
**Response Time:** Within 7 business days for insurance-related inquiries
|
**Response Time:** Within 7 business days for insurance-related inquiries
|
||||||
|
|
||||||
### 10.4 Emergency Legal Matters
|
### 10.4. Emergency Legal Matters
|
||||||
|
|
||||||
For urgent legal matters requiring immediate attention:
|
For urgent legal matters requiring immediate attention:
|
||||||
|
|
||||||
@@ -738,14 +738,6 @@ For urgent legal matters requiring immediate attention:
|
|||||||
|
|
||||||
**Response Time:** Within 24 hours for emergency legal matters
|
**Response Time:** Within 24 hours for emergency legal matters
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 March 2026
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Limitation of Liability and Indemnification Policy provides comprehensive legal protection through risk allocation, liability limitations, and indemnification provisions. By using our Services, you acknowledge and agree to these terms and understand their legal implications. For questions about liability matters, please contact us at legal@nhcarrigan.com.*
|
*This Limitation of Liability and Indemnification Policy provides comprehensive legal protection through risk allocation, liability limitations, and indemnification provisions. By using our Services, you acknowledge and agree to these terms and understand their legal implications. For questions about liability matters, please contact us at legal@nhcarrigan.com.*
|
||||||
|
|||||||
+204
-216
File diff suppressed because it is too large
Load Diff
@@ -6,15 +6,15 @@ title: Privacy Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 About This Policy
|
### 1.1. About This Policy
|
||||||
|
|
||||||
This Privacy Policy ("Policy") sets out how nhcarrigan ("we," "us," "our," or "the Company") collects, uses, stores, and protects your personal information when you use our services, applications, and platforms (collectively, the "Services").
|
This Privacy Policy ("Policy") sets out how NHCarrigan ("we," "us," "our," or "the Company") collects, uses, stores, and protects your personal information when you use our services, applications, and platforms (collectively, the "Services").
|
||||||
|
|
||||||
### 1.2 Policy Applicability
|
### 1.2. Policy Applicability
|
||||||
|
|
||||||
This Policy applies to:
|
This Policy applies to:
|
||||||
|
|
||||||
**(a)** All services, websites, and applications operated by nhcarrigan;
|
**(a)** All services, websites, and applications operated by NHCarrigan;
|
||||||
|
|
||||||
**(b)** All users of our Services, regardless of location;
|
**(b)** All users of our Services, regardless of location;
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ This Policy applies to:
|
|||||||
|
|
||||||
**(d)** Both current and former users of our Services.
|
**(d)** Both current and former users of our Services.
|
||||||
|
|
||||||
### 1.3 Additional Policies
|
### 1.3. Additional Policies
|
||||||
|
|
||||||
Specific Services may be subject to additional privacy notices or terms ("Service-Specific Policies"). Where such policies exist:
|
Specific Services may be subject to additional privacy notices or terms ("Service-Specific Policies"). Where such policies exist:
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ Specific Services may be subject to additional privacy notices or terms ("Servic
|
|||||||
|
|
||||||
**(c)** We shall clearly identify when additional policies apply.
|
**(c)** We shall clearly identify when additional policies apply.
|
||||||
|
|
||||||
### 1.4 Policy Updates
|
### 1.4. Policy Updates
|
||||||
|
|
||||||
We reserve the right to update this Policy at any time. Changes may:
|
We reserve the right to update this Policy at any time. Changes may:
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ We reserve the right to update this Policy at any time. Changes may:
|
|||||||
|
|
||||||
**(c)** Require your continued consent through ongoing use of our Services.
|
**(c)** Require your continued consent through ongoing use of our Services.
|
||||||
|
|
||||||
### 1.5 Acceptance and Consent
|
### 1.5. Acceptance and Consent
|
||||||
|
|
||||||
By using our Services, you:
|
By using our Services, you:
|
||||||
|
|
||||||
@@ -52,13 +52,13 @@ By using our Services, you:
|
|||||||
|
|
||||||
**(c)** Agree to be bound by the current version of this Policy.
|
**(c)** Agree to be bound by the current version of this Policy.
|
||||||
|
|
||||||
### 1.6 Contact for Privacy Matters
|
### 1.6. Contact for Privacy Matters
|
||||||
|
|
||||||
For all privacy-related inquiries, please contact us at: **privacy@nhcarrigan.com**
|
For all privacy-related inquiries, please contact us at: **privacy@nhcarrigan.com**
|
||||||
|
|
||||||
## 2. INFORMATION WE COLLECT
|
## 2. INFORMATION WE COLLECT
|
||||||
|
|
||||||
### 2.1 Types of Personal Information
|
### 2.1. Types of Personal Information
|
||||||
|
|
||||||
We may collect the following categories of personal information:
|
We may collect the following categories of personal information:
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ We may collect the following categories of personal information:
|
|||||||
|
|
||||||
**(e)** **Account Information:** Registration details, preferences, and account settings.
|
**(e)** **Account Information:** Registration details, preferences, and account settings.
|
||||||
|
|
||||||
### 2.2 Methods of Collection
|
### 2.2. Methods of Collection
|
||||||
|
|
||||||
We collect personal information through:
|
We collect personal information through:
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ We collect personal information through:
|
|||||||
|
|
||||||
**(c)** **Third-Party Sources:** Information from integrated services and platforms (with your consent).
|
**(c)** **Third-Party Sources:** Information from integrated services and platforms (with your consent).
|
||||||
|
|
||||||
### 2.3 Undocumented Collection
|
### 2.3. Undocumented Collection
|
||||||
|
|
||||||
Despite our best efforts to maintain comprehensive documentation:
|
Despite our best efforts to maintain comprehensive documentation:
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ Despite our best efforts to maintain comprehensive documentation:
|
|||||||
|
|
||||||
## 3. HOW WE USE YOUR INFORMATION
|
## 3. HOW WE USE YOUR INFORMATION
|
||||||
|
|
||||||
### 3.1 Primary Purposes
|
### 3.1. Primary Purposes
|
||||||
|
|
||||||
We process your personal information for the following purposes:
|
We process your personal information for the following purposes:
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ We process your personal information for the following purposes:
|
|||||||
|
|
||||||
**(e)** **Legal Compliance:** To fulfil our legal obligations and protect our rights.
|
**(e)** **Legal Compliance:** To fulfil our legal obligations and protect our rights.
|
||||||
|
|
||||||
### 3.2 Legal Basis for Processing
|
### 3.2. Legal Basis for Processing
|
||||||
|
|
||||||
Our legal basis for processing personal information includes:
|
Our legal basis for processing personal information includes:
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ Our legal basis for processing personal information includes:
|
|||||||
|
|
||||||
**(d)** **Legal Obligation:** Where required by applicable law.
|
**(d)** **Legal Obligation:** Where required by applicable law.
|
||||||
|
|
||||||
### 3.3 Automated Decision-Making
|
### 3.3. Automated Decision-Making
|
||||||
|
|
||||||
We may use automated systems for:
|
We may use automated systems for:
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ You have the right to request human review of automated decisions that significa
|
|||||||
|
|
||||||
## 4. DATA SHARING AND DISCLOSURE
|
## 4. DATA SHARING AND DISCLOSURE
|
||||||
|
|
||||||
### 4.1 Internal Access
|
### 4.1. Internal Access
|
||||||
|
|
||||||
Access to your personal information within our organisation is restricted to:
|
Access to your personal information within our organisation is restricted to:
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ Access to your personal information within our organisation is restricted to:
|
|||||||
|
|
||||||
**(c)** Individuals involved in legal compliance and security matters.
|
**(c)** Individuals involved in legal compliance and security matters.
|
||||||
|
|
||||||
### 4.2 Third-Party Sharing
|
### 4.2. Third-Party Sharing
|
||||||
|
|
||||||
We may share your information with:
|
We may share your information with:
|
||||||
|
|
||||||
@@ -158,11 +158,11 @@ We may share your information with:
|
|||||||
|
|
||||||
**(d)** **Successors:** In the event of a merger, acquisition, or business transfer.
|
**(d)** **Successors:** In the event of a merger, acquisition, or business transfer.
|
||||||
|
|
||||||
### 4.3 Data Sale Prohibition
|
### 4.3. Data Sale Prohibition
|
||||||
|
|
||||||
We do not and will not sell your personal information to third parties for commercial purposes.
|
We do not and will not sell your personal information to third parties for commercial purposes.
|
||||||
|
|
||||||
### 4.4 International Transfers
|
### 4.4. International Transfers
|
||||||
|
|
||||||
Your information may be transferred to and processed in countries other than your own. We ensure appropriate safeguards are in place for such transfers, including:
|
Your information may be transferred to and processed in countries other than your own. We ensure appropriate safeguards are in place for such transfers, including:
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ Your information may be transferred to and processed in countries other than you
|
|||||||
|
|
||||||
## 5. YOUR PRIVACY RIGHTS
|
## 5. YOUR PRIVACY RIGHTS
|
||||||
|
|
||||||
### 5.1 General Rights
|
### 5.1. General Rights
|
||||||
|
|
||||||
Regardless of your location, you have the following rights regarding your personal information:
|
Regardless of your location, you have the following rights regarding your personal information:
|
||||||
|
|
||||||
@@ -188,7 +188,7 @@ Regardless of your location, you have the following rights regarding your person
|
|||||||
|
|
||||||
**(e)** **Right to Data Portability:** Receive your information in a structured, commonly used format.
|
**(e)** **Right to Data Portability:** Receive your information in a structured, commonly used format.
|
||||||
|
|
||||||
### 5.2 Exercising Your Rights
|
### 5.2. Exercising Your Rights
|
||||||
|
|
||||||
To exercise any of these rights:
|
To exercise any of these rights:
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ To exercise any of these rights:
|
|||||||
|
|
||||||
**(d)** Include any relevant details or documentation to support your request.
|
**(d)** Include any relevant details or documentation to support your request.
|
||||||
|
|
||||||
### 5.3 Response Timeframes
|
### 5.3. Response Timeframes
|
||||||
|
|
||||||
We endeavour to respond to all privacy requests within:
|
We endeavour to respond to all privacy requests within:
|
||||||
|
|
||||||
@@ -210,7 +210,7 @@ We endeavour to respond to all privacy requests within:
|
|||||||
|
|
||||||
**(c)** **Urgent security matters:** Within twenty-four (24) hours where possible.
|
**(c)** **Urgent security matters:** Within twenty-four (24) hours where possible.
|
||||||
|
|
||||||
### 5.4 Limitations on Rights
|
### 5.4. Limitations on Rights
|
||||||
|
|
||||||
Your privacy rights may be limited where:
|
Your privacy rights may be limited where:
|
||||||
|
|
||||||
@@ -224,7 +224,7 @@ Your privacy rights may be limited where:
|
|||||||
|
|
||||||
## 6. DATA RETENTION AND DELETION
|
## 6. DATA RETENTION AND DELETION
|
||||||
|
|
||||||
### 6.1 Retention Principles
|
### 6.1. Retention Principles
|
||||||
|
|
||||||
We retain personal information based on the following principles:
|
We retain personal information based on the following principles:
|
||||||
|
|
||||||
@@ -234,7 +234,7 @@ We retain personal information based on the following principles:
|
|||||||
|
|
||||||
**(c)** **Legal Requirements:** Some information may be retained to comply with legal obligations.
|
**(c)** **Legal Requirements:** Some information may be retained to comply with legal obligations.
|
||||||
|
|
||||||
### 6.2 Retention Periods
|
### 6.2. Retention Periods
|
||||||
|
|
||||||
General retention periods include:
|
General retention periods include:
|
||||||
|
|
||||||
@@ -246,7 +246,7 @@ General retention periods include:
|
|||||||
|
|
||||||
**(d)** **Legal and Compliance Data:** Retained as required by applicable laws.
|
**(d)** **Legal and Compliance Data:** Retained as required by applicable laws.
|
||||||
|
|
||||||
### 6.3 Automated Deletion
|
### 6.3. Automated Deletion
|
||||||
|
|
||||||
Where technically feasible, we implement automated systems to:
|
Where technically feasible, we implement automated systems to:
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ Where technically feasible, we implement automated systems to:
|
|||||||
|
|
||||||
**(c)** Regularly review and purge unnecessary information.
|
**(c)** Regularly review and purge unnecessary information.
|
||||||
|
|
||||||
### 6.4 Backup Retention
|
### 6.4. Backup Retention
|
||||||
|
|
||||||
For system recovery purposes:
|
For system recovery purposes:
|
||||||
|
|
||||||
@@ -268,7 +268,7 @@ For system recovery purposes:
|
|||||||
|
|
||||||
## 7. DATA SECURITY
|
## 7. DATA SECURITY
|
||||||
|
|
||||||
### 7.1 Security Measures
|
### 7.1. Security Measures
|
||||||
|
|
||||||
We implement comprehensive security measures including:
|
We implement comprehensive security measures including:
|
||||||
|
|
||||||
@@ -280,7 +280,7 @@ We implement comprehensive security measures including:
|
|||||||
|
|
||||||
**(d)** **Regular Audits:** Periodic security assessments and vulnerability testing.
|
**(d)** **Regular Audits:** Periodic security assessments and vulnerability testing.
|
||||||
|
|
||||||
### 7.2 Personnel Security
|
### 7.2. Personnel Security
|
||||||
|
|
||||||
All team members with access to personal information:
|
All team members with access to personal information:
|
||||||
|
|
||||||
@@ -292,7 +292,7 @@ All team members with access to personal information:
|
|||||||
|
|
||||||
**(d)** Face disciplinary action for unauthorised access or misuse.
|
**(d)** Face disciplinary action for unauthorised access or misuse.
|
||||||
|
|
||||||
### 7.3 Incident Response
|
### 7.3. Incident Response
|
||||||
|
|
||||||
In the event of a data breach:
|
In the event of a data breach:
|
||||||
|
|
||||||
@@ -304,7 +304,7 @@ In the event of a data breach:
|
|||||||
|
|
||||||
**(d)** We will provide regular updates on our investigation and remediation efforts.
|
**(d)** We will provide regular updates on our investigation and remediation efforts.
|
||||||
|
|
||||||
### 7.4 Third-Party Security
|
### 7.4. Third-Party Security
|
||||||
|
|
||||||
Third-party service providers must:
|
Third-party service providers must:
|
||||||
|
|
||||||
@@ -318,7 +318,7 @@ Third-party service providers must:
|
|||||||
|
|
||||||
## 8. COOKIES AND TRACKING TECHNOLOGIES
|
## 8. COOKIES AND TRACKING TECHNOLOGIES
|
||||||
|
|
||||||
### 8.1 Use of Cookies
|
### 8.1. Use of Cookies
|
||||||
|
|
||||||
We use cookies and similar technologies to:
|
We use cookies and similar technologies to:
|
||||||
|
|
||||||
@@ -330,7 +330,7 @@ We use cookies and similar technologies to:
|
|||||||
|
|
||||||
**(d)** Maintain security and prevent fraud.
|
**(d)** Maintain security and prevent fraud.
|
||||||
|
|
||||||
### 8.2 Types of Cookies
|
### 8.2. Types of Cookies
|
||||||
|
|
||||||
We may use the following types of cookies:
|
We may use the following types of cookies:
|
||||||
|
|
||||||
@@ -342,7 +342,7 @@ We may use the following types of cookies:
|
|||||||
|
|
||||||
**(d)** **Targeting Cookies:** Used to deliver relevant content (with consent).
|
**(d)** **Targeting Cookies:** Used to deliver relevant content (with consent).
|
||||||
|
|
||||||
### 8.3 Cookie Management
|
### 8.3. Cookie Management
|
||||||
|
|
||||||
You can manage cookies through:
|
You can manage cookies through:
|
||||||
|
|
||||||
@@ -356,11 +356,11 @@ Please note that disabling certain cookies may affect the functionality of our S
|
|||||||
|
|
||||||
## 9. CHILDREN'S PRIVACY
|
## 9. CHILDREN'S PRIVACY
|
||||||
|
|
||||||
### 9.1 Age Restrictions
|
### 9.1. Age Restrictions
|
||||||
|
|
||||||
Our Services are not intended for children under the age of thirteen (13), or the minimum digital age of consent in your jurisdiction, whichever is higher.
|
Our Services are not intended for children under the age of thirteen (13), or the minimum digital age of consent in your jurisdiction, whichever is higher.
|
||||||
|
|
||||||
### 9.2 Collection from Children
|
### 9.2. Collection from Children
|
||||||
|
|
||||||
We do not knowingly collect personal information from children under the applicable minimum age. If we become aware that we have collected such information:
|
We do not knowingly collect personal information from children under the applicable minimum age. If we become aware that we have collected such information:
|
||||||
|
|
||||||
@@ -370,7 +370,7 @@ We do not knowingly collect personal information from children under the applica
|
|||||||
|
|
||||||
**(c)** We will take steps to prevent future collection.
|
**(c)** We will take steps to prevent future collection.
|
||||||
|
|
||||||
### 9.3 Parental Rights
|
### 9.3. Parental Rights
|
||||||
|
|
||||||
Parents and guardians have the right to:
|
Parents and guardians have the right to:
|
||||||
|
|
||||||
@@ -382,15 +382,15 @@ Parents and guardians have the right to:
|
|||||||
|
|
||||||
## 10. CONTACT INFORMATION AND COMPLAINTS
|
## 10. CONTACT INFORMATION AND COMPLAINTS
|
||||||
|
|
||||||
### 10.1 Privacy Contact
|
### 10.1. Privacy Contact
|
||||||
|
|
||||||
For all privacy-related matters, contact our Data Protection Officer at:
|
For all privacy-related matters, contact our Data Protection Officer at:
|
||||||
|
|
||||||
**Email:** privacy@nhcarrigan.com
|
**Email:** privacy@nhcarrigan.com
|
||||||
|
|
||||||
**Forum:** https://forum.nhcarrigan.com (for general inquiries)
|
**Discord Community:** https://chat.nhcarrigan.com (for general inquiries)
|
||||||
|
|
||||||
### 10.2 Information to Include
|
### 10.2. Information to Include
|
||||||
|
|
||||||
When contacting us about privacy matters, please provide:
|
When contacting us about privacy matters, please provide:
|
||||||
|
|
||||||
@@ -402,7 +402,7 @@ When contacting us about privacy matters, please provide:
|
|||||||
|
|
||||||
**(d)** Supporting documentation if applicable.
|
**(d)** Supporting documentation if applicable.
|
||||||
|
|
||||||
### 10.3 Response Commitment
|
### 10.3. Response Commitment
|
||||||
|
|
||||||
We commit to:
|
We commit to:
|
||||||
|
|
||||||
@@ -414,7 +414,7 @@ We commit to:
|
|||||||
|
|
||||||
**(d)** Following up to ensure your concerns have been adequately addressed.
|
**(d)** Following up to ensure your concerns have been adequately addressed.
|
||||||
|
|
||||||
### 10.4 Complaints and Escalation
|
### 10.4. Complaints and Escalation
|
||||||
|
|
||||||
If you are not satisfied with our response:
|
If you are not satisfied with our response:
|
||||||
|
|
||||||
@@ -424,13 +424,13 @@ If you are not satisfied with our response:
|
|||||||
|
|
||||||
**(c)** You may seek independent legal advice regarding your rights.
|
**(c)** You may seek independent legal advice regarding your rights.
|
||||||
|
|
||||||
### 10.5 Supervisory Authority Contact
|
### 10.5. Supervisory Authority Contact
|
||||||
|
|
||||||
For complaints in jurisdictions with data protection authorities, you may contact your local supervisory authority. In the European Union, you can find your local authority at: https://edpb.europa.eu/about-edpb/board/members_en
|
For complaints in jurisdictions with data protection authorities, you may contact your local supervisory authority. In the European Union, you can find your local authority at: https://edpb.europa.eu/about-edpb/board/members_en
|
||||||
|
|
||||||
## 11. UPDATES AND EFFECTIVE DATE
|
## 11. UPDATES
|
||||||
|
|
||||||
### 11.1 Policy Updates
|
### 11.1. Policy Updates
|
||||||
|
|
||||||
We may update this Policy periodically to reflect:
|
We may update this Policy periodically to reflect:
|
||||||
|
|
||||||
@@ -442,7 +442,7 @@ We may update this Policy periodically to reflect:
|
|||||||
|
|
||||||
**(d)** Technological developments and security enhancements.
|
**(d)** Technological developments and security enhancements.
|
||||||
|
|
||||||
### 11.2 Notification of Changes
|
### 11.2. Notification of Changes
|
||||||
|
|
||||||
We will notify you of material changes through:
|
We will notify you of material changes through:
|
||||||
|
|
||||||
@@ -452,13 +452,10 @@ We will notify you of material changes through:
|
|||||||
|
|
||||||
**(c)** Updates to our website and documentation.
|
**(c)** Updates to our website and documentation.
|
||||||
|
|
||||||
### 11.3 Version History
|
### 11.3. Version History
|
||||||
|
|
||||||
Previous versions of this Policy are available upon request for transparency and reference purposes.
|
Previous versions of this Policy are available upon request for transparency and reference purposes.
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -6,13 +6,13 @@ title: Security Policy
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Policy Overview
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
This Security Policy ("Policy") establishes the procedures and terms under which we handle the reporting and resolution of security vulnerabilities discovered in our applications, systems, and services. By participating in our security reporting process, you acknowledge and agree to comply with all provisions of this Policy.
|
This Security Policy ("Policy") establishes the procedures and terms under which we handle the reporting and resolution of security vulnerabilities discovered in our applications, systems, and services. By participating in our security reporting process, you acknowledge and agree to comply with all provisions of this Policy.
|
||||||
|
|
||||||
### 1.2 Scope of Coverage
|
### 1.2. Scope of Coverage
|
||||||
|
|
||||||
This Policy applies to all applications, services, and systems maintained by nhcarrigan, including but not limited to:
|
This Policy applies to all applications, services, and systems maintained by NHCarrigan, including but not limited to:
|
||||||
|
|
||||||
**(a)** All primary websites and web applications operated under our domain;
|
**(a)** All primary websites and web applications operated under our domain;
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ This Policy applies to all applications, services, and systems maintained by nhc
|
|||||||
|
|
||||||
**(f)** Associated documentation, support systems, and auxiliary platforms.
|
**(f)** Associated documentation, support systems, and auxiliary platforms.
|
||||||
|
|
||||||
### 1.3 Security Principles
|
### 1.3. Security Principles
|
||||||
|
|
||||||
Our security programme is founded on the following principles:
|
Our security programme is founded on the following principles:
|
||||||
|
|
||||||
@@ -38,13 +38,13 @@ Our security programme is founded on the following principles:
|
|||||||
|
|
||||||
**(d)** **User Protection:** Our primary focus is protecting the confidentiality, integrity, and availability of user data and systems.
|
**(d)** **User Protection:** Our primary focus is protecting the confidentiality, integrity, and availability of user data and systems.
|
||||||
|
|
||||||
### 1.4 Legal Framework
|
### 1.4. Legal Framework
|
||||||
|
|
||||||
This Policy is designed to operate within the framework of applicable laws and regulations, including but not limited to computer fraud and abuse laws, data protection regulations, and responsible disclosure principles recognised in the security research community.
|
This Policy is designed to operate within the framework of applicable laws and regulations, including but not limited to computer fraud and abuse laws, data protection regulations, and responsible disclosure principles recognised in the security research community.
|
||||||
|
|
||||||
## 2. VULNERABILITY REPORTING PROCEDURES
|
## 2. VULNERABILITY REPORTING PROCEDURES
|
||||||
|
|
||||||
### 2.1 Reporting Channels
|
### 2.1. Reporting Channels
|
||||||
|
|
||||||
If you discover a security vulnerability within any of our systems or applications, please report it exclusively through our designated secure reporting channel:
|
If you discover a security vulnerability within any of our systems or applications, please report it exclusively through our designated secure reporting channel:
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ If you discover a security vulnerability within any of our systems or applicatio
|
|||||||
|
|
||||||
**Alternative Contact:** For urgent matters requiring immediate attention, you may also contact our general support team with clear indication of the security nature of your report.
|
**Alternative Contact:** For urgent matters requiring immediate attention, you may also contact our general support team with clear indication of the security nature of your report.
|
||||||
|
|
||||||
### 2.2 Public Disclosure Prohibition
|
### 2.2. Public Disclosure Prohibition
|
||||||
|
|
||||||
To protect our users and systems, you must not disclose security vulnerabilities publicly or through any public channels until we have had reasonable opportunity to investigate and address the issue. Prohibited disclosure methods include, but are not limited to:
|
To protect our users and systems, you must not disclose security vulnerabilities publicly or through any public channels until we have had reasonable opportunity to investigate and address the issue. Prohibited disclosure methods include, but are not limited to:
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ To protect our users and systems, you must not disclose security vulnerabilities
|
|||||||
|
|
||||||
**(f)** Any other medium accessible to the general public.
|
**(f)** Any other medium accessible to the general public.
|
||||||
|
|
||||||
### 2.3 Required Information for Vulnerability Reports
|
### 2.3. Required Information for Vulnerability Reports
|
||||||
|
|
||||||
To facilitate effective investigation and resolution, please include the following information in your vulnerability report:
|
To facilitate effective investigation and resolution, please include the following information in your vulnerability report:
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ To facilitate effective investigation and resolution, please include the followi
|
|||||||
|
|
||||||
**(f)** **Discovery Context:** Information about how the vulnerability was discovered and any tools or techniques used.
|
**(f)** **Discovery Context:** Information about how the vulnerability was discovered and any tools or techniques used.
|
||||||
|
|
||||||
### 2.4 Information Handling and Confidentiality
|
### 2.4. Information Handling and Confidentiality
|
||||||
|
|
||||||
All vulnerability reports and related communications will be handled with strict confidentiality in accordance with our privacy policy and applicable data protection laws. We commit to:
|
All vulnerability reports and related communications will be handled with strict confidentiality in accordance with our privacy policy and applicable data protection laws. We commit to:
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ All vulnerability reports and related communications will be handled with strict
|
|||||||
|
|
||||||
## 3. RESPONSE PROCEDURES AND TIMELINES
|
## 3. RESPONSE PROCEDURES AND TIMELINES
|
||||||
|
|
||||||
### 3.1 Initial Acknowledgement
|
### 3.1. Initial Acknowledgement
|
||||||
|
|
||||||
We will acknowledge receipt of your vulnerability report within the following timeframes:
|
We will acknowledge receipt of your vulnerability report within the following timeframes:
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ We will acknowledge receipt of your vulnerability report within the following ti
|
|||||||
|
|
||||||
**(c)** **Complex Reports:** Within five (5) business days for reports requiring initial technical assessment before acknowledgement.
|
**(c)** **Complex Reports:** Within five (5) business days for reports requiring initial technical assessment before acknowledgement.
|
||||||
|
|
||||||
### 3.2 Assessment and Verification Process
|
### 3.2. Assessment and Verification Process
|
||||||
|
|
||||||
Following initial acknowledgement, our security team will:
|
Following initial acknowledgement, our security team will:
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ Following initial acknowledgement, our security team will:
|
|||||||
|
|
||||||
**(e)** Develop an appropriate response and remediation plan.
|
**(e)** Develop an appropriate response and remediation plan.
|
||||||
|
|
||||||
### 3.3 Communication and Updates
|
### 3.3. Communication and Updates
|
||||||
|
|
||||||
Throughout the investigation and resolution process, we will:
|
Throughout the investigation and resolution process, we will:
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ Throughout the investigation and resolution process, we will:
|
|||||||
|
|
||||||
**(d)** Keep you informed of any changes to our remediation plans or timelines.
|
**(d)** Keep you informed of any changes to our remediation plans or timelines.
|
||||||
|
|
||||||
### 3.4 Resolution Timeline
|
### 3.4. Resolution Timeline
|
||||||
|
|
||||||
We are committed to resolving confirmed vulnerabilities within the following timeframes:
|
We are committed to resolving confirmed vulnerabilities within the following timeframes:
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ We are committed to resolving confirmed vulnerabilities within the following tim
|
|||||||
|
|
||||||
## 4. COORDINATED DISCLOSURE POLICY
|
## 4. COORDINATED DISCLOSURE POLICY
|
||||||
|
|
||||||
### 4.1 Coordinated Disclosure Principles
|
### 4.1. Coordinated Disclosure Principles
|
||||||
|
|
||||||
We practice coordinated disclosure to balance transparency with security. This approach ensures that:
|
We practice coordinated disclosure to balance transparency with security. This approach ensures that:
|
||||||
|
|
||||||
@@ -162,7 +162,7 @@ We practice coordinated disclosure to balance transparency with security. This a
|
|||||||
|
|
||||||
**(c)** The security research community benefits from shared knowledge whilst minimising potential harm.
|
**(c)** The security research community benefits from shared knowledge whilst minimising potential harm.
|
||||||
|
|
||||||
### 4.2 Disclosure Timeline
|
### 4.2. Disclosure Timeline
|
||||||
|
|
||||||
Our standard coordinated disclosure timeline follows this process:
|
Our standard coordinated disclosure timeline follows this process:
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ Our standard coordinated disclosure timeline follows this process:
|
|||||||
|
|
||||||
**(d)** **Public Disclosure:** Joint announcement of vulnerability and resolution (after fix deployment and reasonable notice period).
|
**(d)** **Public Disclosure:** Joint announcement of vulnerability and resolution (after fix deployment and reasonable notice period).
|
||||||
|
|
||||||
### 4.3 Public Acknowledgement
|
### 4.3. Public Acknowledgement
|
||||||
|
|
||||||
With your explicit consent, we may publicly acknowledge your contribution in discovering and reporting the vulnerability after it has been resolved. Such acknowledgement may include:
|
With your explicit consent, we may publicly acknowledge your contribution in discovering and reporting the vulnerability after it has been resolved. Such acknowledgement may include:
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ With your explicit consent, we may publicly acknowledge your contribution in dis
|
|||||||
|
|
||||||
**(d)** References in relevant security documentation or case studies.
|
**(d)** References in relevant security documentation or case studies.
|
||||||
|
|
||||||
### 4.4 Researcher Discretion
|
### 4.4. Researcher Discretion
|
||||||
|
|
||||||
You retain the right to:
|
You retain the right to:
|
||||||
|
|
||||||
@@ -200,11 +200,11 @@ You retain the right to:
|
|||||||
|
|
||||||
## 5. LEGAL SAFE HARBOUR PROVISIONS
|
## 5. LEGAL SAFE HARBOUR PROVISIONS
|
||||||
|
|
||||||
### 5.1 Authorisation for Security Research
|
### 5.1. Authorisation for Security Research
|
||||||
|
|
||||||
We explicitly authorise security research and vulnerability disclosure activities conducted in accordance with this Policy and applicable laws. This authorisation is intended to encourage responsible security research whilst protecting both researchers and our organisation.
|
We explicitly authorise security research and vulnerability disclosure activities conducted in accordance with this Policy and applicable laws. This authorisation is intended to encourage responsible security research whilst protecting both researchers and our organisation.
|
||||||
|
|
||||||
### 5.2 Scope of Safe Harbour Protection
|
### 5.2. Scope of Safe Harbour Protection
|
||||||
|
|
||||||
Our safe harbour provisions apply to security research activities that:
|
Our safe harbour provisions apply to security research activities that:
|
||||||
|
|
||||||
@@ -218,7 +218,7 @@ Our safe harbour provisions apply to security research activities that:
|
|||||||
|
|
||||||
**(e)** Are conducted without commercial motivation or malicious intent.
|
**(e)** Are conducted without commercial motivation or malicious intent.
|
||||||
|
|
||||||
### 5.3 Protected Activities
|
### 5.3. Protected Activities
|
||||||
|
|
||||||
Under this safe harbour, we will not initiate legal action against researchers for activities including:
|
Under this safe harbour, we will not initiate legal action against researchers for activities including:
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ Under this safe harbour, we will not initiate legal action against researchers f
|
|||||||
|
|
||||||
**(d)** Downloading or accessing data that is the direct result of a security vulnerability, provided such access is limited to demonstrating the issue.
|
**(d)** Downloading or accessing data that is the direct result of a security vulnerability, provided such access is limited to demonstrating the issue.
|
||||||
|
|
||||||
### 5.4 Limitations and Exclusions
|
### 5.4. Limitations and Exclusions
|
||||||
|
|
||||||
This safe harbour protection does not apply to:
|
This safe harbour protection does not apply to:
|
||||||
|
|
||||||
@@ -246,7 +246,7 @@ This safe harbour protection does not apply to:
|
|||||||
|
|
||||||
**(f)** Activities conducted after we have requested cessation or identified security policy violations.
|
**(f)** Activities conducted after we have requested cessation or identified security policy violations.
|
||||||
|
|
||||||
### 5.5 Compliance Requirements
|
### 5.5. Compliance Requirements
|
||||||
|
|
||||||
To maintain safe harbour protection, researchers must:
|
To maintain safe harbour protection, researchers must:
|
||||||
|
|
||||||
@@ -262,11 +262,11 @@ To maintain safe harbour protection, researchers must:
|
|||||||
|
|
||||||
## 6. BUG BOUNTY PROGRAMME
|
## 6. BUG BOUNTY PROGRAMME
|
||||||
|
|
||||||
### 6.1 Current Programme Status
|
### 6.1. Current Programme Status
|
||||||
|
|
||||||
At present, we do not operate a formal monetary bug bounty programme. Our security efforts rely on the goodwill and community spirit of security researchers who contribute to improving our security posture on a voluntary basis.
|
At present, we do not operate a formal monetary bug bounty programme. Our security efforts rely on the goodwill and community spirit of security researchers who contribute to improving our security posture on a voluntary basis.
|
||||||
|
|
||||||
### 6.2 Non-Monetary Recognition
|
### 6.2. Non-Monetary Recognition
|
||||||
|
|
||||||
While we do not currently offer financial rewards, we deeply appreciate security researchers' contributions and provide recognition through:
|
While we do not currently offer financial rewards, we deeply appreciate security researchers' contributions and provide recognition through:
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ While we do not currently offer financial rewards, we deeply appreciate security
|
|||||||
|
|
||||||
**(d)** **Networking Opportunities:** Introduction to other security professionals and organisations within our network.
|
**(d)** **Networking Opportunities:** Introduction to other security professionals and organisations within our network.
|
||||||
|
|
||||||
### 6.3 Future Programme Development
|
### 6.3. Future Programme Development
|
||||||
|
|
||||||
We continuously evaluate the possibility of implementing a formal bug bounty programme. Factors influencing this decision include:
|
We continuously evaluate the possibility of implementing a formal bug bounty programme. Factors influencing this decision include:
|
||||||
|
|
||||||
@@ -290,7 +290,7 @@ We continuously evaluate the possibility of implementing a formal bug bounty pro
|
|||||||
|
|
||||||
**(d)** Alignment with our organisational priorities and community values.
|
**(d)** Alignment with our organisational priorities and community values.
|
||||||
|
|
||||||
### 6.4 Alternative Contribution Opportunities
|
### 6.4. Alternative Contribution Opportunities
|
||||||
|
|
||||||
Security researchers interested in contributing to our security efforts may also consider:
|
Security researchers interested in contributing to our security efforts may also consider:
|
||||||
|
|
||||||
@@ -304,7 +304,7 @@ Security researchers interested in contributing to our security efforts may also
|
|||||||
|
|
||||||
## 7. DATA PROTECTION AND PRIVACY
|
## 7. DATA PROTECTION AND PRIVACY
|
||||||
|
|
||||||
### 7.1 Handling of Submitted Information
|
### 7.1. Handling of Submitted Information
|
||||||
|
|
||||||
All information provided in vulnerability reports will be processed and protected in accordance with our Privacy Policy and applicable data protection laws. This includes:
|
All information provided in vulnerability reports will be processed and protected in accordance with our Privacy Policy and applicable data protection laws. This includes:
|
||||||
|
|
||||||
@@ -316,7 +316,7 @@ All information provided in vulnerability reports will be processed and protecte
|
|||||||
|
|
||||||
**(d)** Maintaining confidentiality of researcher information and contact details.
|
**(d)** Maintaining confidentiality of researcher information and contact details.
|
||||||
|
|
||||||
### 7.2 Data Retention Policies
|
### 7.2. Data Retention Policies
|
||||||
|
|
||||||
We retain vulnerability reports and related communications:
|
We retain vulnerability reports and related communications:
|
||||||
|
|
||||||
@@ -328,7 +328,7 @@ We retain vulnerability reports and related communications:
|
|||||||
|
|
||||||
**(d)** **Historical Analysis:** Anonymised trend data may be retained indefinitely for security improvement purposes.
|
**(d)** **Historical Analysis:** Anonymised trend data may be retained indefinitely for security improvement purposes.
|
||||||
|
|
||||||
### 7.3 Confidentiality Commitments
|
### 7.3. Confidentiality Commitments
|
||||||
|
|
||||||
We commit to treating all vulnerability reports as confidential information and will not:
|
We commit to treating all vulnerability reports as confidential information and will not:
|
||||||
|
|
||||||
@@ -340,7 +340,7 @@ We commit to treating all vulnerability reports as confidential information and
|
|||||||
|
|
||||||
**(d)** Publicly discuss specific vulnerability details before coordinated disclosure.
|
**(d)** Publicly discuss specific vulnerability details before coordinated disclosure.
|
||||||
|
|
||||||
### 7.4 Researcher Privacy Rights
|
### 7.4. Researcher Privacy Rights
|
||||||
|
|
||||||
Security researchers maintain standard privacy rights regarding their personal information, including:
|
Security researchers maintain standard privacy rights regarding their personal information, including:
|
||||||
|
|
||||||
@@ -354,11 +354,11 @@ Security researchers maintain standard privacy rights regarding their personal i
|
|||||||
|
|
||||||
## 8. PROACTIVE SECURITY MEASURES
|
## 8. PROACTIVE SECURITY MEASURES
|
||||||
|
|
||||||
### 8.1 Security Monitoring and Assessment
|
### 8.1. Security Monitoring and Assessment
|
||||||
|
|
||||||
To maintain the highest possible security standards and protect user data, we implement comprehensive proactive security measures across all our systems and applications.
|
To maintain the highest possible security standards and protect user data, we implement comprehensive proactive security measures across all our systems and applications.
|
||||||
|
|
||||||
### 8.2 Automated Security Scanning
|
### 8.2. Automated Security Scanning
|
||||||
|
|
||||||
Our security programme includes regular automated scanning and assessment using industry-standard tools:
|
Our security programme includes regular automated scanning and assessment using industry-standard tools:
|
||||||
|
|
||||||
@@ -370,7 +370,7 @@ Our security programme includes regular automated scanning and assessment using
|
|||||||
|
|
||||||
**(d)** **Dependency Scanning:** Continuous monitoring of third-party libraries and components for known vulnerabilities.
|
**(d)** **Dependency Scanning:** Continuous monitoring of third-party libraries and components for known vulnerabilities.
|
||||||
|
|
||||||
### 8.3 Security Tool Integration
|
### 8.3. Security Tool Integration
|
||||||
|
|
||||||
We utilise a comprehensive suite of security tools integrated into our development and deployment processes:
|
We utilise a comprehensive suite of security tools integrated into our development and deployment processes:
|
||||||
|
|
||||||
@@ -384,11 +384,11 @@ We utilise a comprehensive suite of security tools integrated into our developme
|
|||||||
|
|
||||||
**(e)** **Trivy:** Comprehensive vulnerability scanning for containers, filesystems, and cloud configurations.
|
**(e)** **Trivy:** Comprehensive vulnerability scanning for containers, filesystems, and cloud configurations.
|
||||||
|
|
||||||
### 8.4 Public Security Reporting
|
### 8.4. Public Security Reporting
|
||||||
|
|
||||||
We maintain transparency about our security posture through publicly accessible security reports and dashboards:
|
We maintain transparency about our security posture through publicly accessible security reports and dashboards:
|
||||||
|
|
||||||
**(a)** **Quality Dashboard:** Real-time security and quality metrics available at https://quality.nhcarrigan.link;
|
**(a)** **Quality Dashboard:** Real-time security and quality metrics available at https://quality.NHCarrigan.link;
|
||||||
|
|
||||||
**(b)** **Security Reports:** Comprehensive security scan results published at https://security.nhcarrigan.com;
|
**(b)** **Security Reports:** Comprehensive security scan results published at https://security.nhcarrigan.com;
|
||||||
|
|
||||||
@@ -396,7 +396,7 @@ We maintain transparency about our security posture through publicly accessible
|
|||||||
|
|
||||||
**(d)** **Trend Analysis:** Historical data tracking to identify and address security trends over time.
|
**(d)** **Trend Analysis:** Historical data tracking to identify and address security trends over time.
|
||||||
|
|
||||||
### 8.5 Security Development Lifecycle
|
### 8.5. Security Development Lifecycle
|
||||||
|
|
||||||
Our development processes incorporate security at every stage:
|
Our development processes incorporate security at every stage:
|
||||||
|
|
||||||
@@ -410,7 +410,7 @@ Our development processes incorporate security at every stage:
|
|||||||
|
|
||||||
## 9. COMPLIANCE AND REGULATORY CONSIDERATIONS
|
## 9. COMPLIANCE AND REGULATORY CONSIDERATIONS
|
||||||
|
|
||||||
### 9.1 Legal Compliance Requirements
|
### 9.1. Legal Compliance Requirements
|
||||||
|
|
||||||
All security research and vulnerability disclosure activities must comply with applicable laws and regulations, including but not limited to:
|
All security research and vulnerability disclosure activities must comply with applicable laws and regulations, including but not limited to:
|
||||||
|
|
||||||
@@ -422,7 +422,7 @@ All security research and vulnerability disclosure activities must comply with a
|
|||||||
|
|
||||||
**(d)** Industry-specific regulations applicable to our services or user base.
|
**(d)** Industry-specific regulations applicable to our services or user base.
|
||||||
|
|
||||||
### 9.2 International Considerations
|
### 9.2. International Considerations
|
||||||
|
|
||||||
Given the global nature of our services and user base, researchers should be aware that:
|
Given the global nature of our services and user base, researchers should be aware that:
|
||||||
|
|
||||||
@@ -434,7 +434,7 @@ Given the global nature of our services and user base, researchers should be awa
|
|||||||
|
|
||||||
**(d)** Researchers are responsible for ensuring their activities comply with laws in their jurisdiction.
|
**(d)** Researchers are responsible for ensuring their activities comply with laws in their jurisdiction.
|
||||||
|
|
||||||
### 9.3 Ethical Guidelines
|
### 9.3. Ethical Guidelines
|
||||||
|
|
||||||
Beyond legal compliance, we expect all security research to adhere to widely recognised ethical guidelines:
|
Beyond legal compliance, we expect all security research to adhere to widely recognised ethical guidelines:
|
||||||
|
|
||||||
@@ -446,7 +446,7 @@ Beyond legal compliance, we expect all security research to adhere to widely rec
|
|||||||
|
|
||||||
**(d)** **Community Benefit:** Focus on activities that benefit the broader security community and user protection.
|
**(d)** **Community Benefit:** Focus on activities that benefit the broader security community and user protection.
|
||||||
|
|
||||||
### 9.4 Reporting Regulatory Concerns
|
### 9.4. Reporting Regulatory Concerns
|
||||||
|
|
||||||
If vulnerability research reveals potential regulatory compliance issues or legal violations:
|
If vulnerability research reveals potential regulatory compliance issues or legal violations:
|
||||||
|
|
||||||
@@ -460,7 +460,7 @@ If vulnerability research reveals potential regulatory compliance issues or lega
|
|||||||
|
|
||||||
## 10. CONTACT INFORMATION AND SUPPORT
|
## 10. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 10.1 Primary Security Contact
|
### 10.1. Primary Security Contact
|
||||||
|
|
||||||
For all security-related matters, including vulnerability reports, questions about this Policy, and general security inquiries:
|
For all security-related matters, including vulnerability reports, questions about this Policy, and general security inquiries:
|
||||||
|
|
||||||
@@ -470,17 +470,17 @@ For all security-related matters, including vulnerability reports, questions abo
|
|||||||
|
|
||||||
**Emergency Contact:** For critical security issues requiring immediate attention, mark your email with [URGENT] in the subject line
|
**Emergency Contact:** For critical security issues requiring immediate attention, mark your email with [URGENT] in the subject line
|
||||||
|
|
||||||
### 10.2 Alternative Contact Methods
|
### 10.2. Alternative Contact Methods
|
||||||
|
|
||||||
If you are unable to use our primary email contact:
|
If you are unable to use our primary email contact:
|
||||||
|
|
||||||
**General Support:** contact@nhcarrigan.com (clearly mark security-related messages)
|
**General Support:** contact@nhcarrigan.com (clearly mark security-related messages)
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com (for general security discussions only, not vulnerability reports)
|
**Discord Community:** https://chat.nhcarrigan.com (for general security discussions only, not vulnerability reports)
|
||||||
|
|
||||||
**Documentation:** This Policy and related security documentation is maintained at our official documentation site
|
**Documentation:** This Policy and related security documentation is maintained at our official documentation site
|
||||||
|
|
||||||
### 10.3 Response Commitments and Service Levels
|
### 10.3. Response Commitments and Service Levels
|
||||||
|
|
||||||
We commit to maintaining the following response standards:
|
We commit to maintaining the following response standards:
|
||||||
|
|
||||||
@@ -492,7 +492,7 @@ We commit to maintaining the following response standards:
|
|||||||
|
|
||||||
**(d)** **Escalation Path:** Clear escalation procedures for urgent matters or communication issues.
|
**(d)** **Escalation Path:** Clear escalation procedures for urgent matters or communication issues.
|
||||||
|
|
||||||
### 10.4 Communication Preferences and Requirements
|
### 10.4. Communication Preferences and Requirements
|
||||||
|
|
||||||
To ensure effective communication:
|
To ensure effective communication:
|
||||||
|
|
||||||
@@ -504,7 +504,7 @@ To ensure effective communication:
|
|||||||
|
|
||||||
**(d)** **Time Zone Considerations:** Our primary response times are based on Pacific Standard Time business hours.
|
**(d)** **Time Zone Considerations:** Our primary response times are based on Pacific Standard Time business hours.
|
||||||
|
|
||||||
### 10.5 Support Resources
|
### 10.5. Support Resources
|
||||||
|
|
||||||
Additional resources available to security researchers:
|
Additional resources available to security researchers:
|
||||||
|
|
||||||
@@ -518,7 +518,7 @@ Additional resources available to security researchers:
|
|||||||
|
|
||||||
## 11. POLICY UPDATES AND MAINTENANCE
|
## 11. POLICY UPDATES AND MAINTENANCE
|
||||||
|
|
||||||
### 11.1 Regular Review and Updates
|
### 11.1. Regular Review and Updates
|
||||||
|
|
||||||
This Security Policy is reviewed and updated regularly to ensure:
|
This Security Policy is reviewed and updated regularly to ensure:
|
||||||
|
|
||||||
@@ -530,7 +530,7 @@ This Security Policy is reviewed and updated regularly to ensure:
|
|||||||
|
|
||||||
**(d)** **Operational Experience:** Refinement based on our experience with vulnerability reports and security incidents.
|
**(d)** **Operational Experience:** Refinement based on our experience with vulnerability reports and security incidents.
|
||||||
|
|
||||||
### 11.2 Change Notification Process
|
### 11.2. Change Notification Process
|
||||||
|
|
||||||
Changes to this Policy will be communicated through:
|
Changes to this Policy will be communicated through:
|
||||||
|
|
||||||
@@ -542,19 +542,17 @@ Changes to this Policy will be communicated through:
|
|||||||
|
|
||||||
**(d)** **Industry Channels:** Notification through relevant security community channels where appropriate.
|
**(d)** **Industry Channels:** Notification through relevant security community channels where appropriate.
|
||||||
|
|
||||||
### 11.3 Effective Date and Implementation
|
### 11.3. Policy Implementation
|
||||||
|
|
||||||
Policy updates will:
|
Policy updates will:
|
||||||
|
|
||||||
**(a)** Include clear effective dates for all changes;
|
**(a)** Provide reasonable notice periods for significant changes;
|
||||||
|
|
||||||
**(b)** Provide reasonable notice periods for significant changes;
|
**(b)** Maintain backward compatibility for ongoing vulnerability reports;
|
||||||
|
|
||||||
**(c)** Maintain backward compatibility for ongoing vulnerability reports;
|
**(c)** Include transition procedures for any changes affecting active security research.
|
||||||
|
|
||||||
**(d)** Include transition procedures for any changes affecting active security research.
|
### 11.4. Feedback and Continuous Improvement
|
||||||
|
|
||||||
### 11.4 Feedback and Continuous Improvement
|
|
||||||
|
|
||||||
We welcome feedback on this Policy from:
|
We welcome feedback on this Policy from:
|
||||||
|
|
||||||
@@ -568,11 +566,11 @@ We welcome feedback on this Policy from:
|
|||||||
|
|
||||||
## 12. ACKNOWLEDGEMENTS AND RECOGNITION
|
## 12. ACKNOWLEDGEMENTS AND RECOGNITION
|
||||||
|
|
||||||
### 12.1 Community Appreciation
|
### 12.1. Community Appreciation
|
||||||
|
|
||||||
We extend our sincere gratitude to the global security research community for their valuable contributions to improving the security of our systems and protecting our users. The collaborative approach to security research benefits everyone and represents the best of community-driven innovation.
|
We extend our sincere gratitude to the global security research community for their valuable contributions to improving the security of our systems and protecting our users. The collaborative approach to security research benefits everyone and represents the best of community-driven innovation.
|
||||||
|
|
||||||
### 12.2 Commitment to Excellence
|
### 12.2. Commitment to Excellence
|
||||||
|
|
||||||
This Security Policy represents our ongoing commitment to:
|
This Security Policy represents our ongoing commitment to:
|
||||||
|
|
||||||
@@ -584,7 +582,7 @@ This Security Policy represents our ongoing commitment to:
|
|||||||
|
|
||||||
**(d)** **User Protection:** Prioritising the security and privacy of our users above all other considerations.
|
**(d)** **User Protection:** Prioritising the security and privacy of our users above all other considerations.
|
||||||
|
|
||||||
### 12.3 Future Development
|
### 12.3. Future Development
|
||||||
|
|
||||||
We are committed to the ongoing development and improvement of our security programme, including:
|
We are committed to the ongoing development and improvement of our security programme, including:
|
||||||
|
|
||||||
@@ -596,12 +594,6 @@ We are committed to the ongoing development and improvement of our security prog
|
|||||||
|
|
||||||
**(d)** Engagement with the broader security community and industry initiatives.
|
**(d)** Engagement with the broader security community and industry initiatives.
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Policy Version:** 2.0
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*By reporting a security vulnerability to us, you acknowledge that you have read, understood, and agree to comply with this Security Policy. This Policy is designed to promote responsible security research whilst protecting the interests of our users, our organisation, and the broader community. For questions about this Policy or to report security vulnerabilities, please contact us at security@nhcarrigan.com.*
|
*By reporting a security vulnerability to us, you acknowledge that you have read, understood, and agree to comply with this Security Policy. This Policy is designed to promote responsible security research whilst protecting the interests of our users, our organisation, and the broader community. For questions about this Policy or to report security vulnerabilities, please contact us at security@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Service Level Agreement and Warranty Disclaimer
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND SCOPE
|
## 1. INTRODUCTION AND SCOPE
|
||||||
|
|
||||||
### 1.1 Purpose and Application
|
### 1.1. Purpose and Application
|
||||||
|
|
||||||
This Service Level Agreement and Warranty Disclaimer ("SLA") establishes the terms and conditions governing the availability, performance, and reliability of services provided by nhcarrigan ("we," "us," "our," or "the Company"). This SLA applies to all users of our services, applications, and platforms (collectively, the "Services").
|
This Service Level Agreement and Warranty Disclaimer ("SLA") establishes the terms and conditions governing the availability, performance, and reliability of services provided by NHCarrigan ("we," "us," "our," or "the Company"). This SLA applies to all users of our services, applications, and platforms (collectively, the "Services").
|
||||||
|
|
||||||
### 1.2 Integration with Other Policies
|
### 1.2. Integration with Other Policies
|
||||||
|
|
||||||
This SLA supplements and operates in conjunction with:
|
This SLA supplements and operates in conjunction with:
|
||||||
|
|
||||||
@@ -22,11 +22,11 @@ This SLA supplements and operates in conjunction with:
|
|||||||
|
|
||||||
**(d)** All other applicable policies and agreements.
|
**(d)** All other applicable policies and agreements.
|
||||||
|
|
||||||
### 1.3 Scope of Services Covered
|
### 1.3. Scope of Services Covered
|
||||||
|
|
||||||
This SLA applies to:
|
This SLA applies to:
|
||||||
|
|
||||||
**(a)** All websites and web applications operated by nhcarrigan;
|
**(a)** All websites and web applications operated by NHCarrigan;
|
||||||
|
|
||||||
**(b)** Application Programming Interfaces (APIs) and related services;
|
**(b)** Application Programming Interfaces (APIs) and related services;
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ This SLA applies to:
|
|||||||
|
|
||||||
**(e)** Any other services explicitly designated as covered by this SLA.
|
**(e)** Any other services explicitly designated as covered by this SLA.
|
||||||
|
|
||||||
### 1.4 Definitions
|
### 1.4. Definitions
|
||||||
|
|
||||||
For the purposes of this SLA:
|
For the purposes of this SLA:
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ For the purposes of this SLA:
|
|||||||
|
|
||||||
## 2. SERVICE AVAILABILITY COMMITMENTS
|
## 2. SERVICE AVAILABILITY COMMITMENTS
|
||||||
|
|
||||||
### 2.1 General Availability Targets
|
### 2.1. General Availability Targets
|
||||||
|
|
||||||
We endeavour to maintain the following availability targets for our Services:
|
We endeavour to maintain the following availability targets for our Services:
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ We endeavour to maintain the following availability targets for our Services:
|
|||||||
|
|
||||||
**(d)** **Documentation Services**: 98.0% uptime on a monthly basis, excluding scheduled maintenance.
|
**(d)** **Documentation Services**: 98.0% uptime on a monthly basis, excluding scheduled maintenance.
|
||||||
|
|
||||||
### 2.2 Availability Calculation Methodology
|
### 2.2. Availability Calculation Methodology
|
||||||
|
|
||||||
Availability percentages are calculated as follows:
|
Availability percentages are calculated as follows:
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ Availability percentages are calculated as follows:
|
|||||||
|
|
||||||
**(d)** **Verification**: All calculations subject to verification through our monitoring systems.
|
**(d)** **Verification**: All calculations subject to verification through our monitoring systems.
|
||||||
|
|
||||||
### 2.3 Scheduled Maintenance
|
### 2.3. Scheduled Maintenance
|
||||||
|
|
||||||
We reserve the right to perform scheduled maintenance with the following provisions:
|
We reserve the right to perform scheduled maintenance with the following provisions:
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ We reserve the right to perform scheduled maintenance with the following provisi
|
|||||||
|
|
||||||
**(d)** **Emergency Maintenance**: May be performed without advance notice when necessary for security or stability.
|
**(d)** **Emergency Maintenance**: May be performed without advance notice when necessary for security or stability.
|
||||||
|
|
||||||
### 2.4 Service Availability Exclusions
|
### 2.4. Service Availability Exclusions
|
||||||
|
|
||||||
The following circumstances are excluded from availability calculations:
|
The following circumstances are excluded from availability calculations:
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ The following circumstances are excluded from availability calculations:
|
|||||||
|
|
||||||
## 3. PERFORMANCE STANDARDS
|
## 3. PERFORMANCE STANDARDS
|
||||||
|
|
||||||
### 3.1 Response Time Targets
|
### 3.1. Response Time Targets
|
||||||
|
|
||||||
We endeavour to maintain the following response time targets:
|
We endeavour to maintain the following response time targets:
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ We endeavour to maintain the following response time targets:
|
|||||||
|
|
||||||
**(d)** **Static Content Delivery**: Average content delivery time under 1 second globally.
|
**(d)** **Static Content Delivery**: Average content delivery time under 1 second globally.
|
||||||
|
|
||||||
### 3.2 Performance Measurement
|
### 3.2. Performance Measurement
|
||||||
|
|
||||||
Performance metrics are measured using:
|
Performance metrics are measured using:
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ Performance metrics are measured using:
|
|||||||
|
|
||||||
**(d)** **Third-Party Verification**: Independent monitoring services where applicable.
|
**(d)** **Third-Party Verification**: Independent monitoring services where applicable.
|
||||||
|
|
||||||
### 3.3 Performance Factors
|
### 3.3. Performance Factors
|
||||||
|
|
||||||
Performance may be affected by:
|
Performance may be affected by:
|
||||||
|
|
||||||
@@ -146,11 +146,11 @@ Performance may be affected by:
|
|||||||
|
|
||||||
## 4. WARRANTY DISCLAIMERS
|
## 4. WARRANTY DISCLAIMERS
|
||||||
|
|
||||||
### 4.1 Reference to Comprehensive Warranty Disclaimers
|
### 4.1. Reference to Comprehensive Warranty Disclaimers
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive warranty disclaimers, including all general, software, third-party service, and data warranties, are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
**IMPORTANT: Comprehensive warranty disclaimers, including all general, software, third-party service, and data warranties, are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
### 4.2 SLA-Specific Disclaimers
|
### 4.2. SLA-Specific Disclaimers
|
||||||
|
|
||||||
In addition to the comprehensive disclaimers in our Liability Policy, we specifically disclaim any warranties regarding:
|
In addition to the comprehensive disclaimers in our Liability Policy, we specifically disclaim any warranties regarding:
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ In addition to the comprehensive disclaimers in our Liability Policy, we specifi
|
|||||||
|
|
||||||
## 5. SERVICE LIMITATIONS AND RESTRICTIONS
|
## 5. SERVICE LIMITATIONS AND RESTRICTIONS
|
||||||
|
|
||||||
### 5.1 Usage Limitations
|
### 5.1. Usage Limitations
|
||||||
|
|
||||||
Our Services are subject to the following limitations:
|
Our Services are subject to the following limitations:
|
||||||
|
|
||||||
@@ -176,7 +176,7 @@ Our Services are subject to the following limitations:
|
|||||||
|
|
||||||
**(d)** **Feature Restrictions**: Certain features may be limited or restricted based on usage patterns.
|
**(d)** **Feature Restrictions**: Certain features may be limited or restricted based on usage patterns.
|
||||||
|
|
||||||
### 5.2 Geographic and Legal Restrictions
|
### 5.2. Geographic and Legal Restrictions
|
||||||
|
|
||||||
Services may be subject to:
|
Services may be subject to:
|
||||||
|
|
||||||
@@ -188,7 +188,7 @@ Services may be subject to:
|
|||||||
|
|
||||||
**(d)** **Content Restrictions**: Geographic restrictions on certain content or features.
|
**(d)** **Content Restrictions**: Geographic restrictions on certain content or features.
|
||||||
|
|
||||||
### 5.3 Technical Limitations
|
### 5.3. Technical Limitations
|
||||||
|
|
||||||
Users should be aware of the following technical limitations:
|
Users should be aware of the following technical limitations:
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ Users should be aware of the following technical limitations:
|
|||||||
|
|
||||||
## 6. SERVICE LEVEL REMEDIES AND CREDITS
|
## 6. SERVICE LEVEL REMEDIES AND CREDITS
|
||||||
|
|
||||||
### 6.1 Service Level Breach Determination
|
### 6.1. Service Level Breach Determination
|
||||||
|
|
||||||
A Service Level breach occurs when:
|
A Service Level breach occurs when:
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ A Service Level breach occurs when:
|
|||||||
|
|
||||||
**(d)** The breach is not due to excluded circumstances listed in Section 2.4.
|
**(d)** The breach is not due to excluded circumstances listed in Section 2.4.
|
||||||
|
|
||||||
### 6.2 Available Remedies
|
### 6.2. Available Remedies
|
||||||
|
|
||||||
**IMPORTANT: SERVICE CREDITS ARE YOUR SOLE AND EXCLUSIVE REMEDY FOR SERVICE LEVEL BREACHES.**
|
**IMPORTANT: SERVICE CREDITS ARE YOUR SOLE AND EXCLUSIVE REMEDY FOR SERVICE LEVEL BREACHES.**
|
||||||
|
|
||||||
@@ -228,7 +228,7 @@ Available remedies for verified Service Level breaches include:
|
|||||||
|
|
||||||
**(d)** **Alternative Solutions**: Reasonable alternative arrangements where technically feasible.
|
**(d)** **Alternative Solutions**: Reasonable alternative arrangements where technically feasible.
|
||||||
|
|
||||||
### 6.3 Remedy Limitations
|
### 6.3. Remedy Limitations
|
||||||
|
|
||||||
Service Level remedies are subject to the following limitations:
|
Service Level remedies are subject to the following limitations:
|
||||||
|
|
||||||
@@ -240,7 +240,7 @@ Service Level remedies are subject to the following limitations:
|
|||||||
|
|
||||||
**(d)** **Good Faith Usage**: Remedies available only to users in good standing with all applicable policies.
|
**(d)** **Good Faith Usage**: Remedies available only to users in good standing with all applicable policies.
|
||||||
|
|
||||||
### 6.4 Remedy Request Process
|
### 6.4. Remedy Request Process
|
||||||
|
|
||||||
To request Service Level remedies:
|
To request Service Level remedies:
|
||||||
|
|
||||||
@@ -254,7 +254,7 @@ To request Service Level remedies:
|
|||||||
|
|
||||||
## 7. FORCE MAJEURE AND EXTERNAL FACTORS
|
## 7. FORCE MAJEURE AND EXTERNAL FACTORS
|
||||||
|
|
||||||
### 7.1 Force Majeure Events
|
### 7.1. Force Majeure Events
|
||||||
|
|
||||||
We shall not be liable for service disruptions caused by force majeure events including:
|
We shall not be liable for service disruptions caused by force majeure events including:
|
||||||
|
|
||||||
@@ -266,7 +266,7 @@ We shall not be liable for service disruptions caused by force majeure events in
|
|||||||
|
|
||||||
**(d)** **Pandemic Events**: Public health emergencies that affect our operations or service delivery.
|
**(d)** **Pandemic Events**: Public health emergencies that affect our operations or service delivery.
|
||||||
|
|
||||||
### 7.2 Third-Party Dependencies
|
### 7.2. Third-Party Dependencies
|
||||||
|
|
||||||
Our Services rely on various third-party providers, and we cannot guarantee:
|
Our Services rely on various third-party providers, and we cannot guarantee:
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ Our Services rely on various third-party providers, and we cannot guarantee:
|
|||||||
|
|
||||||
**(d)** **Content Delivery Networks**: Performance of content distribution services.
|
**(d)** **Content Delivery Networks**: Performance of content distribution services.
|
||||||
|
|
||||||
### 7.3 Cyber Security Threats
|
### 7.3. Cyber Security Threats
|
||||||
|
|
||||||
Service availability may be affected by:
|
Service availability may be affected by:
|
||||||
|
|
||||||
@@ -292,7 +292,7 @@ Service availability may be affected by:
|
|||||||
|
|
||||||
## 8. MONITORING AND REPORTING
|
## 8. MONITORING AND REPORTING
|
||||||
|
|
||||||
### 8.1 Service Monitoring
|
### 8.1. Service Monitoring
|
||||||
|
|
||||||
We maintain comprehensive service monitoring including:
|
We maintain comprehensive service monitoring including:
|
||||||
|
|
||||||
@@ -304,7 +304,7 @@ We maintain comprehensive service monitoring including:
|
|||||||
|
|
||||||
**(d)** **Performance Metrics**: Continuous measurement of response times and system performance.
|
**(d)** **Performance Metrics**: Continuous measurement of response times and system performance.
|
||||||
|
|
||||||
### 8.2 Status Communication
|
### 8.2. Status Communication
|
||||||
|
|
||||||
Service status information is communicated through:
|
Service status information is communicated through:
|
||||||
|
|
||||||
@@ -316,7 +316,7 @@ Service status information is communicated through:
|
|||||||
|
|
||||||
**(d)** **Email Notifications**: Direct notifications to users for significant service impacts (where contact information is available).
|
**(d)** **Email Notifications**: Direct notifications to users for significant service impacts (where contact information is available).
|
||||||
|
|
||||||
### 8.3 Transparency Reports
|
### 8.3. Transparency Reports
|
||||||
|
|
||||||
We publish regular transparency reports including:
|
We publish regular transparency reports including:
|
||||||
|
|
||||||
@@ -330,7 +330,7 @@ We publish regular transparency reports including:
|
|||||||
|
|
||||||
## 9. USER RESPONSIBILITIES AND OBLIGATIONS
|
## 9. USER RESPONSIBILITIES AND OBLIGATIONS
|
||||||
|
|
||||||
### 9.1 Proper Usage Requirements
|
### 9.1. Proper Usage Requirements
|
||||||
|
|
||||||
To ensure optimal service performance, users must:
|
To ensure optimal service performance, users must:
|
||||||
|
|
||||||
@@ -342,7 +342,7 @@ To ensure optimal service performance, users must:
|
|||||||
|
|
||||||
**(d)** **Maintain Account Security**: Implement appropriate security measures for account access.
|
**(d)** **Maintain Account Security**: Implement appropriate security measures for account access.
|
||||||
|
|
||||||
### 9.2 System Requirements
|
### 9.2. System Requirements
|
||||||
|
|
||||||
Users are responsible for:
|
Users are responsible for:
|
||||||
|
|
||||||
@@ -354,7 +354,7 @@ Users are responsible for:
|
|||||||
|
|
||||||
**(d)** **Security Software**: Managing security software that may interfere with service access.
|
**(d)** **Security Software**: Managing security software that may interfere with service access.
|
||||||
|
|
||||||
### 9.3 Data Management
|
### 9.3. Data Management
|
||||||
|
|
||||||
Users must:
|
Users must:
|
||||||
|
|
||||||
@@ -368,11 +368,11 @@ Users must:
|
|||||||
|
|
||||||
## 10. LIMITATION OF LIABILITY
|
## 10. LIMITATION OF LIABILITY
|
||||||
|
|
||||||
### 10.1 Reference to Comprehensive Liability Framework
|
### 10.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
**IMPORTANT: Comprehensive liability limitations, damage exclusions, maximum liability caps, and all related legal protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all liability matters related to service level performance.**
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, maximum liability caps, and all related legal protections are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all liability matters related to service level performance.**
|
||||||
|
|
||||||
### 10.2 SLA-Specific Liability Clarifications
|
### 10.2. SLA-Specific Liability Clarifications
|
||||||
|
|
||||||
In addition to the comprehensive protections in our Liability Policy:
|
In addition to the comprehensive protections in our Liability Policy:
|
||||||
|
|
||||||
@@ -384,13 +384,13 @@ In addition to the comprehensive protections in our Liability Policy:
|
|||||||
|
|
||||||
## 11. INDEMNIFICATION
|
## 11. INDEMNIFICATION
|
||||||
|
|
||||||
### 11.1 Reference to Comprehensive Indemnification Framework
|
### 11.1. Reference to Comprehensive Indemnification Framework
|
||||||
|
|
||||||
**IMPORTANT: All indemnification obligations, procedures, scope, and related provisions are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all indemnification matters related to SLA compliance and service usage.**
|
**IMPORTANT: All indemnification obligations, procedures, scope, and related provisions are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and governs all indemnification matters related to SLA compliance and service usage.**
|
||||||
|
|
||||||
## 12. DISPUTE RESOLUTION
|
## 12. DISPUTE RESOLUTION
|
||||||
|
|
||||||
### 12.1 Initial Resolution Procedures
|
### 12.1. Initial Resolution Procedures
|
||||||
|
|
||||||
Before initiating formal legal proceedings, parties agree to attempt resolution through:
|
Before initiating formal legal proceedings, parties agree to attempt resolution through:
|
||||||
|
|
||||||
@@ -402,7 +402,7 @@ Before initiating formal legal proceedings, parties agree to attempt resolution
|
|||||||
|
|
||||||
**(d)** **Documentation**: Maintenance of detailed records of resolution attempts.
|
**(d)** **Documentation**: Maintenance of detailed records of resolution attempts.
|
||||||
|
|
||||||
### 12.2 Governing Law and Jurisdiction
|
### 12.2. Governing Law and Jurisdiction
|
||||||
|
|
||||||
This SLA shall be governed by:
|
This SLA shall be governed by:
|
||||||
|
|
||||||
@@ -416,7 +416,7 @@ This SLA shall be governed by:
|
|||||||
|
|
||||||
## 13. MODIFICATIONS AND UPDATES
|
## 13. MODIFICATIONS AND UPDATES
|
||||||
|
|
||||||
### 13.1 Right to Modify
|
### 13.1. Right to Modify
|
||||||
|
|
||||||
We reserve the right to modify this SLA at any time to:
|
We reserve the right to modify this SLA at any time to:
|
||||||
|
|
||||||
@@ -428,7 +428,7 @@ We reserve the right to modify this SLA at any time to:
|
|||||||
|
|
||||||
**(d)** **User Feedback**: Incorporate feedback and lessons learned from service operations.
|
**(d)** **User Feedback**: Incorporate feedback and lessons learned from service operations.
|
||||||
|
|
||||||
### 13.2 Modification Notice
|
### 13.2. Modification Notice
|
||||||
|
|
||||||
Material changes to this SLA will be communicated through:
|
Material changes to this SLA will be communicated through:
|
||||||
|
|
||||||
@@ -440,19 +440,19 @@ Material changes to this SLA will be communicated through:
|
|||||||
|
|
||||||
**(d)** **Advance Notice**: Minimum 30 days advance notice for material changes affecting service levels.
|
**(d)** **Advance Notice**: Minimum 30 days advance notice for material changes affecting service levels.
|
||||||
|
|
||||||
### 13.3 Acceptance of Modifications
|
### 13.3. Acceptance of Modifications
|
||||||
|
|
||||||
**(a)** **Continued Use**: Continued use of Services after modification notice constitutes acceptance;
|
**(a)** **Continued Use**: Continued use of Services after modification notice constitutes acceptance;
|
||||||
|
|
||||||
**(b)** **Opt-Out Right**: You may discontinue service usage if you disagree with modifications;
|
**(b)** **Opt-Out Right**: You may discontinue service usage if you disagree with modifications;
|
||||||
|
|
||||||
**(c)** **Effective Date**: Modifications become effective on the date specified in the notice;
|
**(c)** **Implementation**: Modifications become effective as specified in the notice;
|
||||||
|
|
||||||
**(d)** **Version Control**: Current and historical versions available for reference.
|
**(d)** **Version Control**: Current and historical versions available for reference.
|
||||||
|
|
||||||
## 14. CONTACT INFORMATION AND SUPPORT
|
## 14. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 14.1 SLA-Related Inquiries
|
### 14.1. SLA-Related Inquiries
|
||||||
|
|
||||||
For questions about this SLA or service level issues:
|
For questions about this SLA or service level issues:
|
||||||
|
|
||||||
@@ -462,7 +462,7 @@ For questions about this SLA or service level issues:
|
|||||||
|
|
||||||
**Response Time:** Within 2 business days for SLA-related inquiries
|
**Response Time:** Within 2 business days for SLA-related inquiries
|
||||||
|
|
||||||
### 14.2 Service Level Remedy Requests
|
### 14.2. Service Level Remedy Requests
|
||||||
|
|
||||||
For Service Level remedy requests:
|
For Service Level remedy requests:
|
||||||
|
|
||||||
@@ -472,17 +472,17 @@ For Service Level remedy requests:
|
|||||||
|
|
||||||
**Response Time:** Within 10 business days for remedy determinations
|
**Response Time:** Within 10 business days for remedy determinations
|
||||||
|
|
||||||
### 14.3 Technical Support
|
### 14.3. Technical Support
|
||||||
|
|
||||||
For general technical support:
|
For general technical support:
|
||||||
|
|
||||||
**Email:** support@nhcarrigan.com
|
**Email:** support@nhcarrigan.com
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Response Time:** Within 48 hours for technical support requests
|
**Response Time:** Within 48 hours for technical support requests
|
||||||
|
|
||||||
### 14.4 Legal and Compliance Matters
|
### 14.4. Legal and Compliance Matters
|
||||||
|
|
||||||
For legal matters related to this SLA:
|
For legal matters related to this SLA:
|
||||||
|
|
||||||
@@ -492,14 +492,6 @@ For legal matters related to this SLA:
|
|||||||
|
|
||||||
**Response Time:** Within 5 business days for legal inquiries
|
**Response Time:** Within 5 business days for legal inquiries
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 March 2026
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Service Level Agreement and Warranty Disclaimer defines our service commitments whilst protecting against unfounded warranty claims. By using our Services, you acknowledge understanding of these terms and agree to the limitations and obligations described herein. For questions about service levels or to report issues, please contact us at sla@nhcarrigan.com.*
|
*This Service Level Agreement and Warranty Disclaimer defines our service commitments whilst protecting against unfounded warranty claims. By using our Services, you acknowledge understanding of these terms and agree to the limitations and obligations described herein. For questions about service levels or to report issues, please contact us at sla@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Data Subprocessors
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND OVERVIEW
|
## 1. INTRODUCTION AND OVERVIEW
|
||||||
|
|
||||||
### 1.1 Purpose and Scope
|
### 1.1. Purpose and Scope
|
||||||
|
|
||||||
This document provides comprehensive information about third-party entities that process personal data on behalf of nhcarrigan ("we," "us," "our," or "the Company"). By using our services, you acknowledge that your data may be processed by these subprocessors in accordance with their respective privacy policies and our contractual agreements.
|
This document provides comprehensive information about third-party entities that process personal data on behalf of NHCarrigan ("we," "us," "our," or "the Company"). By using our services, you acknowledge that your data may be processed by these subprocessors in accordance with their respective privacy policies and our contractual agreements.
|
||||||
|
|
||||||
### 1.2 Legal Framework
|
### 1.2. Legal Framework
|
||||||
|
|
||||||
This disclosure is provided in accordance with:
|
This disclosure is provided in accordance with:
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ This disclosure is provided in accordance with:
|
|||||||
|
|
||||||
**(d)** Industry best practices for data processing transparency.
|
**(d)** Industry best practices for data processing transparency.
|
||||||
|
|
||||||
### 1.3 Data Processing Principles
|
### 1.3. Data Processing Principles
|
||||||
|
|
||||||
All subprocessor relationships are governed by:
|
All subprocessor relationships are governed by:
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ All subprocessor relationships are governed by:
|
|||||||
|
|
||||||
**(d)** **Contractual Protection:** Formal agreements govern all data processing relationships.
|
**(d)** **Contractual Protection:** Formal agreements govern all data processing relationships.
|
||||||
|
|
||||||
### 1.4 User Rights and Protections
|
### 1.4. User Rights and Protections
|
||||||
|
|
||||||
Your rights regarding subprocessor data processing include:
|
Your rights regarding subprocessor data processing include:
|
||||||
|
|
||||||
@@ -48,13 +48,13 @@ Your rights regarding subprocessor data processing include:
|
|||||||
|
|
||||||
## 2. PRIMARY SUBPROCESSORS
|
## 2. PRIMARY SUBPROCESSORS
|
||||||
|
|
||||||
### 2.1 Definition and Role
|
### 2.1. Definition and Role
|
||||||
|
|
||||||
Primary subprocessors are third-party entities that directly process, store, or manage data on our behalf as part of our core service delivery. These relationships involve direct contractual arrangements and technical integrations.
|
Primary subprocessors are third-party entities that directly process, store, or manage data on our behalf as part of our core service delivery. These relationships involve direct contractual arrangements and technical integrations.
|
||||||
|
|
||||||
### 2.2 Primary Subprocessor Details
|
### 2.2. Primary Subprocessor Details
|
||||||
|
|
||||||
#### 2.2.1 Anthropic
|
#### 2.2.1. Anthropic
|
||||||
|
|
||||||
**Data Processing Role:** Artificial Intelligence and Natural Language Processing
|
**Data Processing Role:** Artificial Intelligence and Natural Language Processing
|
||||||
|
|
||||||
@@ -79,7 +79,7 @@ Primary subprocessors are third-party entities that directly process, store, or
|
|||||||
|
|
||||||
**Privacy Policy:** https://www.anthropic.com/privacy
|
**Privacy Policy:** https://www.anthropic.com/privacy
|
||||||
|
|
||||||
#### 2.2.2 DigitalOcean
|
#### 2.2.2. DigitalOcean
|
||||||
|
|
||||||
**Data Processing Role:** Infrastructure and Hosting Services
|
**Data Processing Role:** Infrastructure and Hosting Services
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ Primary subprocessors are third-party entities that directly process, store, or
|
|||||||
|
|
||||||
**Privacy Policy:** https://www.digitalocean.com/legal/privacy-policy
|
**Privacy Policy:** https://www.digitalocean.com/legal/privacy-policy
|
||||||
|
|
||||||
#### 2.2.3 MongoDB
|
#### 2.2.3. MongoDB
|
||||||
|
|
||||||
**Data Processing Role:** Database Management and Storage
|
**Data Processing Role:** Database Management and Storage
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ Primary subprocessors are third-party entities that directly process, store, or
|
|||||||
|
|
||||||
**Privacy Policy:** https://www.mongodb.com/legal/privacy-policy
|
**Privacy Policy:** https://www.mongodb.com/legal/privacy-policy
|
||||||
|
|
||||||
#### 2.2.4 Stripe
|
#### 2.2.4. Stripe
|
||||||
|
|
||||||
**Data Processing Role:** Payment Processing and Identity Verification
|
**Data Processing Role:** Payment Processing and Identity Verification
|
||||||
|
|
||||||
@@ -159,22 +159,22 @@ Primary subprocessors are third-party entities that directly process, store, or
|
|||||||
|
|
||||||
## 3. SECONDARY SUBPROCESSORS
|
## 3. SECONDARY SUBPROCESSORS
|
||||||
|
|
||||||
### 3.1 Definition and Role
|
### 3.1. Definition and Role
|
||||||
|
|
||||||
Secondary subprocessors are platforms and services that users interact with directly to access our services. While we do not have direct contractual control over these entities, user interaction with our services through these platforms may result in data processing by these entities under their own terms and policies.
|
Secondary subprocessors are platforms and services that users interact with directly to access our services. While we do not have direct contractual control over these entities, user interaction with our services through these platforms may result in data processing by these entities under their own terms and policies.
|
||||||
|
|
||||||
### 3.2 Platform Integration Notice
|
### 3.2. Platform Integration Notice
|
||||||
|
|
||||||
When you access our services through third-party platforms, your interactions are subject to both our privacy policy and the privacy policies of these platforms. We recommend reviewing the privacy policies of all platforms you use to access our services.
|
When you access our services through third-party platforms, your interactions are subject to both our privacy policy and the privacy policies of these platforms. We recommend reviewing the privacy policies of all platforms you use to access our services.
|
||||||
|
|
||||||
### 3.3 Secondary Subprocessor Platforms
|
### 3.3. Secondary Subprocessor Platforms
|
||||||
|
|
||||||
#### 3.3.1 Discord
|
#### 3.3.1. Discord
|
||||||
|
|
||||||
**Relationship Type:** Community Platform Integration
|
**Relationship Type:** Community Platform Integration
|
||||||
|
|
||||||
**Data Processing Context:**
|
**Data Processing Context:**
|
||||||
- User interactions in Discord servers managed by or affiliated with nhcarrigan
|
- User interactions in Discord servers managed by or affiliated with NHCarrigan
|
||||||
- Bot services and integrations provided through Discord
|
- Bot services and integrations provided through Discord
|
||||||
- Community management and moderation activities
|
- Community management and moderation activities
|
||||||
|
|
||||||
@@ -182,7 +182,7 @@ When you access our services through third-party platforms, your interactions ar
|
|||||||
|
|
||||||
**Privacy Policy:** https://discord.com/privacy
|
**Privacy Policy:** https://discord.com/privacy
|
||||||
|
|
||||||
#### 3.3.2 GitHub
|
#### 3.3.2. GitHub
|
||||||
|
|
||||||
**Relationship Type:** Development Platform and Code Repository
|
**Relationship Type:** Development Platform and Code Repository
|
||||||
|
|
||||||
@@ -196,7 +196,7 @@ When you access our services through third-party platforms, your interactions ar
|
|||||||
|
|
||||||
**Privacy Policy:** https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement
|
**Privacy Policy:** https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement
|
||||||
|
|
||||||
#### 3.3.3 PayPal
|
#### 3.3.3. PayPal
|
||||||
|
|
||||||
**Relationship Type:** Alternative Payment Processing
|
**Relationship Type:** Alternative Payment Processing
|
||||||
|
|
||||||
@@ -209,7 +209,7 @@ When you access our services through third-party platforms, your interactions ar
|
|||||||
|
|
||||||
**Privacy Policy:** https://www.paypal.com/us/legalhub/privacy-full
|
**Privacy Policy:** https://www.paypal.com/us/legalhub/privacy-full
|
||||||
|
|
||||||
#### 3.3.4 Twitch
|
#### 3.3.4. Twitch
|
||||||
|
|
||||||
**Relationship Type:** Live Streaming Platform Integration
|
**Relationship Type:** Live Streaming Platform Integration
|
||||||
|
|
||||||
@@ -224,7 +224,7 @@ When you access our services through third-party platforms, your interactions ar
|
|||||||
|
|
||||||
## 4. SUBPROCESSOR MANAGEMENT AND GOVERNANCE
|
## 4. SUBPROCESSOR MANAGEMENT AND GOVERNANCE
|
||||||
|
|
||||||
### 4.1 Due Diligence Process
|
### 4.1. Due Diligence Process
|
||||||
|
|
||||||
Before engaging any primary subprocessor, we conduct comprehensive due diligence including:
|
Before engaging any primary subprocessor, we conduct comprehensive due diligence including:
|
||||||
|
|
||||||
@@ -236,7 +236,7 @@ Before engaging any primary subprocessor, we conduct comprehensive due diligence
|
|||||||
|
|
||||||
**(d)** **Contract Negotiation:** Establishment of data processing agreements with appropriate protections.
|
**(d)** **Contract Negotiation:** Establishment of data processing agreements with appropriate protections.
|
||||||
|
|
||||||
### 4.2 Ongoing Monitoring
|
### 4.2. Ongoing Monitoring
|
||||||
|
|
||||||
We maintain ongoing oversight of subprocessor relationships through:
|
We maintain ongoing oversight of subprocessor relationships through:
|
||||||
|
|
||||||
@@ -248,7 +248,7 @@ We maintain ongoing oversight of subprocessor relationships through:
|
|||||||
|
|
||||||
**(d)** **Contract Management:** Regular review and update of contractual terms.
|
**(d)** **Contract Management:** Regular review and update of contractual terms.
|
||||||
|
|
||||||
### 4.3 Data Processing Agreements
|
### 4.3. Data Processing Agreements
|
||||||
|
|
||||||
All primary subprocessors are bound by data processing agreements that include:
|
All primary subprocessors are bound by data processing agreements that include:
|
||||||
|
|
||||||
@@ -260,7 +260,7 @@ All primary subprocessors are bound by data processing agreements that include:
|
|||||||
|
|
||||||
**(d)** **Audit Rights:** Our right to audit subprocessor data processing practices.
|
**(d)** **Audit Rights:** Our right to audit subprocessor data processing practices.
|
||||||
|
|
||||||
### 4.4 Subprocessor Change Management
|
### 4.4. Subprocessor Change Management
|
||||||
|
|
||||||
Changes to subprocessor arrangements are managed through:
|
Changes to subprocessor arrangements are managed through:
|
||||||
|
|
||||||
@@ -274,7 +274,7 @@ Changes to subprocessor arrangements are managed through:
|
|||||||
|
|
||||||
## 5. DATA TRANSFER AND SECURITY
|
## 5. DATA TRANSFER AND SECURITY
|
||||||
|
|
||||||
### 5.1 International Data Transfers
|
### 5.1. International Data Transfers
|
||||||
|
|
||||||
When data is transferred internationally to subprocessors, we ensure appropriate safeguards through:
|
When data is transferred internationally to subprocessors, we ensure appropriate safeguards through:
|
||||||
|
|
||||||
@@ -286,7 +286,7 @@ When data is transferred internationally to subprocessors, we ensure appropriate
|
|||||||
|
|
||||||
**(d)** **Binding Corporate Rules:** Acceptance of subprocessors with approved internal data transfer rules.
|
**(d)** **Binding Corporate Rules:** Acceptance of subprocessors with approved internal data transfer rules.
|
||||||
|
|
||||||
### 5.2 Security Requirements
|
### 5.2. Security Requirements
|
||||||
|
|
||||||
All primary subprocessors must maintain security measures including:
|
All primary subprocessors must maintain security measures including:
|
||||||
|
|
||||||
@@ -298,7 +298,7 @@ All primary subprocessors must maintain security measures including:
|
|||||||
|
|
||||||
**(d)** **Incident Response:** Established procedures for responding to security incidents.
|
**(d)** **Incident Response:** Established procedures for responding to security incidents.
|
||||||
|
|
||||||
### 5.3 Compliance and Certifications
|
### 5.3. Compliance and Certifications
|
||||||
|
|
||||||
We prefer subprocessors with recognised compliance certifications such as:
|
We prefer subprocessors with recognised compliance certifications such as:
|
||||||
|
|
||||||
@@ -310,7 +310,7 @@ We prefer subprocessors with recognised compliance certifications such as:
|
|||||||
|
|
||||||
**(d)** **GDPR Compliance:** Demonstrated compliance with General Data Protection Regulation.
|
**(d)** **GDPR Compliance:** Demonstrated compliance with General Data Protection Regulation.
|
||||||
|
|
||||||
### 5.4 Data Breach Response
|
### 5.4. Data Breach Response
|
||||||
|
|
||||||
In the event of a data breach involving a subprocessor:
|
In the event of a data breach involving a subprocessor:
|
||||||
|
|
||||||
@@ -324,7 +324,7 @@ In the event of a data breach involving a subprocessor:
|
|||||||
|
|
||||||
## 6. USER RIGHTS AND CONTROL
|
## 6. USER RIGHTS AND CONTROL
|
||||||
|
|
||||||
### 6.1 Transparency Rights
|
### 6.1. Transparency Rights
|
||||||
|
|
||||||
Users have the right to:
|
Users have the right to:
|
||||||
|
|
||||||
@@ -336,7 +336,7 @@ Users have the right to:
|
|||||||
|
|
||||||
**(d)** **Contact:** Direct communication channels for subprocessor-related concerns.
|
**(d)** **Contact:** Direct communication channels for subprocessor-related concerns.
|
||||||
|
|
||||||
### 6.2 Data Subject Rights
|
### 6.2. Data Subject Rights
|
||||||
|
|
||||||
Regarding data processed by subprocessors, users may:
|
Regarding data processed by subprocessors, users may:
|
||||||
|
|
||||||
@@ -348,7 +348,7 @@ Regarding data processed by subprocessors, users may:
|
|||||||
|
|
||||||
**(d)** **Restrict Processing:** Limit how data is processed by subprocessors.
|
**(d)** **Restrict Processing:** Limit how data is processed by subprocessors.
|
||||||
|
|
||||||
### 6.3 Exercise of Rights
|
### 6.3. Exercise of Rights
|
||||||
|
|
||||||
To exercise rights regarding subprocessor data processing:
|
To exercise rights regarding subprocessor data processing:
|
||||||
|
|
||||||
@@ -360,7 +360,7 @@ To exercise rights regarding subprocessor data processing:
|
|||||||
|
|
||||||
**(d)** **Response Time:** Allow reasonable time for investigation and response.
|
**(d)** **Response Time:** Allow reasonable time for investigation and response.
|
||||||
|
|
||||||
### 6.4 Complaint Mechanisms
|
### 6.4. Complaint Mechanisms
|
||||||
|
|
||||||
If you have concerns about subprocessor data processing:
|
If you have concerns about subprocessor data processing:
|
||||||
|
|
||||||
@@ -374,19 +374,19 @@ If you have concerns about subprocessor data processing:
|
|||||||
|
|
||||||
## 7. UPDATES AND CHANGES
|
## 7. UPDATES AND CHANGES
|
||||||
|
|
||||||
### 7.1 Change Notification Process
|
### 7.1. Change Notification Process
|
||||||
|
|
||||||
We will notify users of changes to subprocessor arrangements through:
|
We will notify users of changes to subprocessor arrangements through:
|
||||||
|
|
||||||
**(a)** **Email Notification:** Direct notification to registered users for significant changes;
|
**(a)** **Email Notification:** Direct notification to registered users for significant changes;
|
||||||
|
|
||||||
**(b)** **Website Updates:** Updates to this document with change logs and effective dates;
|
**(b)** **Website Updates:** Updates to this document with change logs;
|
||||||
|
|
||||||
**(c)** **Service Notifications:** In-app notifications where technically feasible;
|
**(c)** **Service Notifications:** In-app notifications where technically feasible;
|
||||||
|
|
||||||
**(d)** **Community Announcements:** Public announcements in community forums.
|
**(d)** **Community Announcements:** Public announcements in community forums.
|
||||||
|
|
||||||
### 7.2 Types of Changes Requiring Notification
|
### 7.2. Types of Changes Requiring Notification
|
||||||
|
|
||||||
Changes requiring advance notification include:
|
Changes requiring advance notification include:
|
||||||
|
|
||||||
@@ -398,7 +398,7 @@ Changes requiring advance notification include:
|
|||||||
|
|
||||||
**(d)** **Security Changes:** Material changes to security measures or protections.
|
**(d)** **Security Changes:** Material changes to security measures or protections.
|
||||||
|
|
||||||
### 7.3 Objection Rights
|
### 7.3. Objection Rights
|
||||||
|
|
||||||
If you object to changes in subprocessor arrangements:
|
If you object to changes in subprocessor arrangements:
|
||||||
|
|
||||||
@@ -410,7 +410,7 @@ If you object to changes in subprocessor arrangements:
|
|||||||
|
|
||||||
**(d)** **Service Termination:** You may terminate services if objections cannot be accommodated.
|
**(d)** **Service Termination:** You may terminate services if objections cannot be accommodated.
|
||||||
|
|
||||||
### 7.4 Emergency Changes
|
### 7.4. Emergency Changes
|
||||||
|
|
||||||
In emergency situations requiring immediate subprocessor changes:
|
In emergency situations requiring immediate subprocessor changes:
|
||||||
|
|
||||||
@@ -424,7 +424,7 @@ In emergency situations requiring immediate subprocessor changes:
|
|||||||
|
|
||||||
## 8. CONTACT INFORMATION AND SUPPORT
|
## 8. CONTACT INFORMATION AND SUPPORT
|
||||||
|
|
||||||
### 8.1 Primary Contact
|
### 8.1. Primary Contact
|
||||||
|
|
||||||
For questions about subprocessor data processing:
|
For questions about subprocessor data processing:
|
||||||
|
|
||||||
@@ -434,7 +434,7 @@ For questions about subprocessor data processing:
|
|||||||
|
|
||||||
**Response Time:** Within 5 business days for standard inquiries
|
**Response Time:** Within 5 business days for standard inquiries
|
||||||
|
|
||||||
### 8.2 Rights Requests
|
### 8.2. Rights Requests
|
||||||
|
|
||||||
For exercising data subject rights regarding subprocessor processing:
|
For exercising data subject rights regarding subprocessor processing:
|
||||||
|
|
||||||
@@ -444,7 +444,7 @@ For exercising data subject rights regarding subprocessor processing:
|
|||||||
|
|
||||||
**Required Information:** Please include your full name, account information, and specific request details
|
**Required Information:** Please include your full name, account information, and specific request details
|
||||||
|
|
||||||
### 8.3 Complaints and Concerns
|
### 8.3. Complaints and Concerns
|
||||||
|
|
||||||
For complaints about subprocessor data processing:
|
For complaints about subprocessor data processing:
|
||||||
|
|
||||||
@@ -454,19 +454,19 @@ For complaints about subprocessor data processing:
|
|||||||
|
|
||||||
**Alternative:** Contact relevant supervisory authorities in your jurisdiction
|
**Alternative:** Contact relevant supervisory authorities in your jurisdiction
|
||||||
|
|
||||||
### 8.4 Technical Support
|
### 8.4. Technical Support
|
||||||
|
|
||||||
For technical issues related to third-party platform integrations:
|
For technical issues related to third-party platform integrations:
|
||||||
|
|
||||||
**Email:** support@nhcarrigan.com
|
**Email:** support@nhcarrigan.com
|
||||||
|
|
||||||
**Community Forum:** https://forum.nhcarrigan.com
|
**Discord Community:** https://chat.nhcarrigan.com
|
||||||
|
|
||||||
**Response Time:** Within 48 hours for technical support requests
|
**Response Time:** Within 48 hours for technical support requests
|
||||||
|
|
||||||
## 9. COMPLIANCE AND REGULATORY INFORMATION
|
## 9. COMPLIANCE AND REGULATORY INFORMATION
|
||||||
|
|
||||||
### 9.1 Regulatory Framework
|
### 9.1. Regulatory Framework
|
||||||
|
|
||||||
This subprocessor disclosure is maintained in compliance with:
|
This subprocessor disclosure is maintained in compliance with:
|
||||||
|
|
||||||
@@ -478,7 +478,7 @@ This subprocessor disclosure is maintained in compliance with:
|
|||||||
|
|
||||||
**(d)** **Industry Standards:** Best practices for data processing transparency.
|
**(d)** **Industry Standards:** Best practices for data processing transparency.
|
||||||
|
|
||||||
### 9.2 Regular Review
|
### 9.2. Regular Review
|
||||||
|
|
||||||
This document is reviewed and updated:
|
This document is reviewed and updated:
|
||||||
|
|
||||||
@@ -490,7 +490,7 @@ This document is reviewed and updated:
|
|||||||
|
|
||||||
**(d)** **Regulatory Updates:** Updates following changes in applicable laws or regulations.
|
**(d)** **Regulatory Updates:** Updates following changes in applicable laws or regulations.
|
||||||
|
|
||||||
### 9.3 Documentation Standards
|
### 9.3. Documentation Standards
|
||||||
|
|
||||||
We maintain documentation standards including:
|
We maintain documentation standards including:
|
||||||
|
|
||||||
@@ -502,14 +502,6 @@ We maintain documentation standards including:
|
|||||||
|
|
||||||
**(d)** **Stakeholder Input:** Consideration of feedback from users and privacy advocates.
|
**(d)** **Stakeholder Input:** Consideration of feedback from users and privacy advocates.
|
||||||
|
|
||||||
**Document Version:** 2.0
|
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Next Review Date:** 15 September 2026
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This document provides transparency about our data processing relationships to help you make informed decisions about using our services. By using our services, you acknowledge understanding of these subprocessor arrangements and consent to the data processing described herein. For questions or concerns about subprocessor data processing, please contact us at privacy@nhcarrigan.com.*
|
*This document provides transparency about our data processing relationships to help you make informed decisions about using our services. By using our services, you acknowledge understanding of these subprocessor arrangements and consent to the data processing described herein. For questions or concerns about subprocessor data processing, please contact us at privacy@nhcarrigan.com.*
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ title: Terms of Service
|
|||||||
|
|
||||||
## 1. INTRODUCTION AND DEFINITIONS
|
## 1. INTRODUCTION AND DEFINITIONS
|
||||||
|
|
||||||
### 1.1 About These Terms
|
### 1.1. About These Terms
|
||||||
|
|
||||||
These Terms of Service ("Terms") constitute a legally binding agreement between you and nhcarrigan ("we," "us," "our," or "the Company"). By accessing or using any of our applications, services, or platforms (collectively, the "Services"), you acknowledge that you have read, understood, and agree to be bound by these Terms and all incorporated policies.
|
These Terms of Service ("Terms") constitute a legally binding agreement between you and NHCarrigan ("we," "us," "our," or "the Company"). By accessing or using any of our applications, services, or platforms (collectively, the "Services"), you acknowledge that you have read, understood, and agree to be bound by these Terms and all incorporated policies.
|
||||||
|
|
||||||
### 1.2 Incorporated Policies
|
### 1.2. Incorporated Policies
|
||||||
|
|
||||||
These Terms incorporate by reference the following additional policies, which form an integral part of your agreement with us:
|
These Terms incorporate by reference the following additional policies, which form an integral part of your agreement with us:
|
||||||
|
|
||||||
@@ -30,21 +30,21 @@ These Terms incorporate by reference the following additional policies, which fo
|
|||||||
|
|
||||||
**(h)** **Data Subprocessors**: Information about third-party data processing relationships.
|
**(h)** **Data Subprocessors**: Information about third-party data processing relationships.
|
||||||
|
|
||||||
### 1.3 Definitions
|
### 1.3. Definitions
|
||||||
|
|
||||||
For the purposes of these Terms:
|
For the purposes of these Terms:
|
||||||
|
|
||||||
**(a)** "Application" means any software application, website, platform, or digital service owned or operated by nhcarrigan;
|
**(a)** "Application" means any software application, website, platform, or digital service owned or operated by NHCarrigan;
|
||||||
|
|
||||||
**(b)** "Content" means all information, data, text, software, music, sound, photographs, graphics, video, messages, or other materials;
|
**(b)** "Content" means all information, data, text, software, music, sound, photographs, graphics, video, messages, or other materials;
|
||||||
|
|
||||||
**(c)** "Services" means all applications, platforms, tools, and related services provided by nhcarrigan;
|
**(c)** "Services" means all applications, platforms, tools, and related services provided by NHCarrigan;
|
||||||
|
|
||||||
**(d)** "User" means any individual or entity that accesses or uses the Services;
|
**(d)** "User" means any individual or entity that accesses or uses the Services;
|
||||||
|
|
||||||
**(e)** "Account" means any user account created to access specific features of the Services.
|
**(e)** "Account" means any user account created to access specific features of the Services.
|
||||||
|
|
||||||
### 1.3 Acceptance of Terms
|
### 1.3. Acceptance of Terms
|
||||||
|
|
||||||
By using our Services, you represent and warrant that:
|
By using our Services, you represent and warrant that:
|
||||||
|
|
||||||
@@ -56,11 +56,11 @@ By using our Services, you represent and warrant that:
|
|||||||
|
|
||||||
**(d)** All information you provide is accurate and complete.
|
**(d)** All information you provide is accurate and complete.
|
||||||
|
|
||||||
### 1.4 Scope of Application
|
### 1.4. Scope of Application
|
||||||
|
|
||||||
These Terms govern your use of all Services, including but not limited to:
|
These Terms govern your use of all Services, including but not limited to:
|
||||||
|
|
||||||
**(a)** All websites and web applications operated by nhcarrigan;
|
**(a)** All websites and web applications operated by NHCarrigan;
|
||||||
|
|
||||||
**(b)** Mobile applications and desktop software;
|
**(b)** Mobile applications and desktop software;
|
||||||
|
|
||||||
@@ -70,11 +70,11 @@ These Terms govern your use of all Services, including but not limited to:
|
|||||||
|
|
||||||
## 2. MODIFICATIONS TO TERMS
|
## 2. MODIFICATIONS TO TERMS
|
||||||
|
|
||||||
### 2.1 Right to Modify
|
### 2.1. Right to Modify
|
||||||
|
|
||||||
We reserve the right, at our sole discretion, to modify, amend, supplement, or replace any provision of these Terms at any time without prior notice. Such modifications shall be effective immediately upon publication on our Services.
|
We reserve the right, at our sole discretion, to modify, amend, supplement, or replace any provision of these Terms at any time without prior notice. Such modifications shall be effective immediately upon publication on our Services.
|
||||||
|
|
||||||
### 2.2 Notification of Changes
|
### 2.2. Notification of Changes
|
||||||
|
|
||||||
We shall make reasonable efforts to notify users of material changes to these Terms through:
|
We shall make reasonable efforts to notify users of material changes to these Terms through:
|
||||||
|
|
||||||
@@ -84,17 +84,17 @@ We shall make reasonable efforts to notify users of material changes to these Te
|
|||||||
|
|
||||||
**(c)** In-application notifications where technically feasible.
|
**(c)** In-application notifications where technically feasible.
|
||||||
|
|
||||||
### 2.3 Acceptance of Modifications
|
### 2.3. Acceptance of Modifications
|
||||||
|
|
||||||
Your continued use of the Services following the publication of modified Terms constitutes your acceptance of such modifications. If you do not agree to the modified Terms, you must immediately discontinue use of all Services.
|
Your continued use of the Services following the publication of modified Terms constitutes your acceptance of such modifications. If you do not agree to the modified Terms, you must immediately discontinue use of all Services.
|
||||||
|
|
||||||
### 2.4 Version Control
|
### 2.4. Version Control
|
||||||
|
|
||||||
The current version of these Terms shall always be available on our website, with the effective date clearly indicated. We may, at our discretion, maintain an archive of previous versions.
|
The current version of these Terms shall always be available on our website. We may, at our discretion, maintain an archive of previous versions.
|
||||||
|
|
||||||
## 3. USER ELIGIBILITY AND ACCOUNT REQUIREMENTS
|
## 3. USER ELIGIBILITY AND ACCOUNT REQUIREMENTS
|
||||||
|
|
||||||
### 3.1 Age Requirements
|
### 3.1. Age Requirements
|
||||||
|
|
||||||
By agreeing to these Terms, you represent and warrant that:
|
By agreeing to these Terms, you represent and warrant that:
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ By agreeing to these Terms, you represent and warrant that:
|
|||||||
|
|
||||||
**(c)** Your parent or legal guardian has reviewed and agreed to these Terms on your behalf, if applicable.
|
**(c)** Your parent or legal guardian has reviewed and agreed to these Terms on your behalf, if applicable.
|
||||||
|
|
||||||
### 3.2 Account Creation and Management
|
### 3.2. Account Creation and Management
|
||||||
|
|
||||||
Where account creation is required:
|
Where account creation is required:
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ Where account creation is required:
|
|||||||
|
|
||||||
**(d)** You accept full responsibility for all activities that occur under your account.
|
**(d)** You accept full responsibility for all activities that occur under your account.
|
||||||
|
|
||||||
### 3.3 Account Termination Rights
|
### 3.3. Account Termination Rights
|
||||||
|
|
||||||
We reserve the right to suspend or terminate your account immediately, with or without notice, if:
|
We reserve the right to suspend or terminate your account immediately, with or without notice, if:
|
||||||
|
|
||||||
@@ -130,23 +130,23 @@ We reserve the right to suspend or terminate your account immediately, with or w
|
|||||||
|
|
||||||
## 4. PROHIBITED USES AND CONDUCT
|
## 4. PROHIBITED USES AND CONDUCT
|
||||||
|
|
||||||
### 4.1 Reference to Detailed Policies
|
### 4.1. Reference to Detailed Policies
|
||||||
|
|
||||||
Detailed prohibitions and conduct requirements are set forth in our Acceptable Use Policy, which is incorporated herein by reference. Users must comply with all provisions of the Acceptable Use Policy in addition to these Terms.
|
Detailed prohibitions and conduct requirements are set forth in our Acceptable Use Policy, which is incorporated herein by reference. Users must comply with all provisions of the Acceptable Use Policy in addition to these Terms.
|
||||||
|
|
||||||
### 4.2 General Prohibition Summary
|
### 4.2. General Prohibition Summary
|
||||||
|
|
||||||
Without limiting the detailed provisions in our Acceptable Use Policy, users shall not use our Services for any unlawful purpose or in any manner that violates applicable laws, regulations, or the rights of others.
|
Without limiting the detailed provisions in our Acceptable Use Policy, users shall not use our Services for any unlawful purpose or in any manner that violates applicable laws, regulations, or the rights of others.
|
||||||
|
|
||||||
### 4.3 Intellectual Property Compliance
|
### 4.3. Intellectual Property Compliance
|
||||||
|
|
||||||
You acknowledge that all content and materials on our Services are protected by intellectual property laws. Unauthorised use may result in immediate termination and legal action. Detailed intellectual property obligations are set forth in our Acceptable Use Policy.
|
You acknowledge that all content and materials on our Services are protected by intellectual property laws. Unauthorised use may result in immediate termination and legal action. Detailed intellectual property obligations are set forth in our Acceptable Use Policy.
|
||||||
|
|
||||||
## 5. USER-GENERATED CONTENT
|
## 5. USER-GENERATED CONTENT
|
||||||
|
|
||||||
### 5.1 Content Licence Grant
|
### 5.1. Content Licence Grant
|
||||||
|
|
||||||
By submitting any content to our Services, you grant nhcarrigan:
|
By submitting any content to our Services, you grant NHCarrigan:
|
||||||
|
|
||||||
**(a)** A non-exclusive, royalty-free, perpetual, irrevocable licence to use, reproduce, modify, adapt, publish, translate, distribute, and display such content;
|
**(a)** A non-exclusive, royalty-free, perpetual, irrevocable licence to use, reproduce, modify, adapt, publish, translate, distribute, and display such content;
|
||||||
|
|
||||||
@@ -154,7 +154,7 @@ By submitting any content to our Services, you grant nhcarrigan:
|
|||||||
|
|
||||||
**(c)** The right to use such content for any lawful purpose, including commercial purposes.
|
**(c)** The right to use such content for any lawful purpose, including commercial purposes.
|
||||||
|
|
||||||
### 5.2 Content Representations
|
### 5.2. Content Representations
|
||||||
|
|
||||||
You represent and warrant that:
|
You represent and warrant that:
|
||||||
|
|
||||||
@@ -164,13 +164,13 @@ You represent and warrant that:
|
|||||||
|
|
||||||
**(c)** The content complies with all applicable laws and these Terms.
|
**(c)** The content complies with all applicable laws and these Terms.
|
||||||
|
|
||||||
### 5.3 Content Moderation
|
### 5.3. Content Moderation
|
||||||
|
|
||||||
Content moderation standards and procedures are detailed in our Content and Moderation Policy, which is incorporated herein by reference. We reserve the right to moderate content in accordance with that Policy and may take appropriate enforcement actions for policy violations.
|
Content moderation standards and procedures are detailed in our Content and Moderation Policy, which is incorporated herein by reference. We reserve the right to moderate content in accordance with that Policy and may take appropriate enforcement actions for policy violations.
|
||||||
|
|
||||||
## 6. SERVICE AVAILABILITY AND MODIFICATIONS
|
## 6. SERVICE AVAILABILITY AND MODIFICATIONS
|
||||||
|
|
||||||
### 6.1 Right to Refuse or Discontinue Service
|
### 6.1. Right to Refuse or Discontinue Service
|
||||||
|
|
||||||
We reserve the right, at our sole discretion and without prior notice, to:
|
We reserve the right, at our sole discretion and without prior notice, to:
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ We reserve the right, at our sole discretion and without prior notice, to:
|
|||||||
|
|
||||||
**(c)** Impose limits on certain features or restrict access to parts of our Services.
|
**(c)** Impose limits on certain features or restrict access to parts of our Services.
|
||||||
|
|
||||||
### 6.2 Technical Limitations and Data Transmission
|
### 6.2. Technical Limitations and Data Transmission
|
||||||
|
|
||||||
You acknowledge and accept that:
|
You acknowledge and accept that:
|
||||||
|
|
||||||
@@ -192,7 +192,7 @@ You acknowledge and accept that:
|
|||||||
|
|
||||||
**(d)** We are not liable for any loss, alteration, or unauthorised access to data during transmission.
|
**(d)** We are not liable for any loss, alteration, or unauthorised access to data during transmission.
|
||||||
|
|
||||||
### 6.3 Usage Restrictions
|
### 6.3. Usage Restrictions
|
||||||
|
|
||||||
Without our express written consent, you shall not:
|
Without our express written consent, you shall not:
|
||||||
|
|
||||||
@@ -208,7 +208,7 @@ Without our express written consent, you shall not:
|
|||||||
|
|
||||||
## 7. INFORMATION ACCURACY AND LIABILITY
|
## 7. INFORMATION ACCURACY AND LIABILITY
|
||||||
|
|
||||||
### 7.1 Information Disclaimer
|
### 7.1. Information Disclaimer
|
||||||
|
|
||||||
We strive to provide accurate and current information through our Services. However, we make no representations or warranties regarding:
|
We strive to provide accurate and current information through our Services. However, we make no representations or warranties regarding:
|
||||||
|
|
||||||
@@ -218,7 +218,7 @@ We strive to provide accurate and current information through our Services. Howe
|
|||||||
|
|
||||||
**(c)** The availability or functionality of any service or feature.
|
**(c)** The availability or functionality of any service or feature.
|
||||||
|
|
||||||
### 7.2 User Responsibility for Information
|
### 7.2. User Responsibility for Information
|
||||||
|
|
||||||
You acknowledge and agree that:
|
You acknowledge and agree that:
|
||||||
|
|
||||||
@@ -228,7 +228,7 @@ You acknowledge and agree that:
|
|||||||
|
|
||||||
**(c)** Any reliance upon information obtained through our Services is at your sole risk.
|
**(c)** Any reliance upon information obtained through our Services is at your sole risk.
|
||||||
|
|
||||||
### 7.3 Updates and Corrections
|
### 7.3. Updates and Corrections
|
||||||
|
|
||||||
We reserve the right to:
|
We reserve the right to:
|
||||||
|
|
||||||
@@ -240,15 +240,15 @@ We reserve the right to:
|
|||||||
|
|
||||||
## 8. THIRD-PARTY SERVICES AND CONTENT
|
## 8. THIRD-PARTY SERVICES AND CONTENT
|
||||||
|
|
||||||
### 8.1 Third-Party Integration
|
### 8.1. Third-Party Integration
|
||||||
|
|
||||||
Our Services may integrate with or link to third-party services, applications, or content ("Third-Party Services"). Such integration does not constitute our endorsement of the Third-Party Services.
|
Our Services may integrate with or link to third-party services, applications, or content ("Third-Party Services"). Such integration does not constitute our endorsement of the Third-Party Services.
|
||||||
|
|
||||||
### 8.2 Third-Party Terms and Policies
|
### 8.2. Third-Party Terms and Policies
|
||||||
|
|
||||||
Your use of Third-Party Services may be subject to separate terms of service, privacy policies, and other agreements with the third-party providers. You are responsible for reviewing and complying with such terms.
|
Your use of Third-Party Services may be subject to separate terms of service, privacy policies, and other agreements with the third-party providers. You are responsible for reviewing and complying with such terms.
|
||||||
|
|
||||||
### 8.3 Disclaimer for Third-Party Services
|
### 8.3. Disclaimer for Third-Party Services
|
||||||
|
|
||||||
We are not responsible for and make no warranties regarding:
|
We are not responsible for and make no warranties regarding:
|
||||||
|
|
||||||
@@ -262,59 +262,59 @@ We are not responsible for and make no warranties regarding:
|
|||||||
|
|
||||||
## 9. PRIVACY AND DATA PROTECTION
|
## 9. PRIVACY AND DATA PROTECTION
|
||||||
|
|
||||||
### 9.1 Privacy Policy
|
### 9.1. Privacy Policy
|
||||||
|
|
||||||
Your privacy is important to us. Our collection, use, and protection of your personal information is governed by our Privacy Policy, which is incorporated into these Terms by reference.
|
Your privacy is important to us. Our collection, use, and protection of your personal information is governed by our Privacy Policy, which is incorporated into these Terms by reference.
|
||||||
|
|
||||||
### 9.2 Data Processing Consent
|
### 9.2. Data Processing Consent
|
||||||
|
|
||||||
By using our Services, you consent to our processing of your personal information in accordance with our Privacy Policy and applicable data protection laws.
|
By using our Services, you consent to our processing of your personal information in accordance with our Privacy Policy and applicable data protection laws.
|
||||||
|
|
||||||
### 9.3 Data Security
|
### 9.3. Data Security
|
||||||
|
|
||||||
Whilst we implement reasonable security measures to protect your information, we cannot guarantee absolute security. You acknowledge that any transmission of data is at your own risk.
|
Whilst we implement reasonable security measures to protect your information, we cannot guarantee absolute security. You acknowledge that any transmission of data is at your own risk.
|
||||||
|
|
||||||
## 10. DISCLAIMERS AND WARRANTIES
|
## 10. DISCLAIMERS AND WARRANTIES
|
||||||
|
|
||||||
### 10.1 Reference to Comprehensive Disclaimers
|
### 10.1. Reference to Comprehensive Disclaimers
|
||||||
|
|
||||||
Comprehensive warranty disclaimers and service limitations are set forth in our Service Level Agreement and Warranty Disclaimer, and our Limitation of Liability and Indemnification Policy, both of which are incorporated herein by reference.
|
Comprehensive warranty disclaimers and service limitations are set forth in our Service Level Agreement and Warranty Disclaimer, and our Limitation of Liability and Indemnification Policy, both of which are incorporated herein by reference.
|
||||||
|
|
||||||
### 10.2 Summary Disclaimer
|
### 10.2. Summary Disclaimer
|
||||||
|
|
||||||
**IMPORTANT: Our Services are provided on an "AS IS" and "AS AVAILABLE" basis without warranties of any kind. We disclaim all warranties including merchantability, fitness for purpose, and non-infringement.**
|
**IMPORTANT: Our Services are provided on an "AS IS" and "AS AVAILABLE" basis without warranties of any kind. We disclaim all warranties including merchantability, fitness for purpose, and non-infringement.**
|
||||||
|
|
||||||
### 10.3 Professional Advice Disclaimer
|
### 10.3. Professional Advice Disclaimer
|
||||||
|
|
||||||
Information provided through our Services is for general purposes only and does not constitute professional advice. Users should consult qualified professionals for specific advice.
|
Information provided through our Services is for general purposes only and does not constitute professional advice. Users should consult qualified professionals for specific advice.
|
||||||
|
|
||||||
## 11. LIMITATION OF LIABILITY
|
## 11. LIMITATION OF LIABILITY
|
||||||
|
|
||||||
### 11.1 Reference to Comprehensive Liability Limitations
|
### 11.1. Reference to Comprehensive Liability Limitations
|
||||||
|
|
||||||
Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and constitutes an integral part of these Terms.
|
Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference and constitutes an integral part of these Terms.
|
||||||
|
|
||||||
### 11.2 Summary of Key Limitations
|
### 11.2. Summary of Key Limitations
|
||||||
|
|
||||||
**TO THE MAXIMUM EXTENT PERMITTED BY LAW, WE SHALL NOT BE LIABLE FOR INDIRECT, CONSEQUENTIAL, OR PUNITIVE DAMAGES. OUR TOTAL LIABILITY IS LIMITED AS SPECIFIED IN OUR LIABILITY POLICY.**
|
**TO THE MAXIMUM EXTENT PERMITTED BY LAW, WE SHALL NOT BE LIABLE FOR INDIRECT, CONSEQUENTIAL, OR PUNITIVE DAMAGES. OUR TOTAL LIABILITY IS LIMITED AS SPECIFIED IN OUR LIABILITY POLICY.**
|
||||||
|
|
||||||
### 11.3 Jurisdictional Adaptation
|
### 11.3. Jurisdictional Adaptation
|
||||||
|
|
||||||
Liability limitations apply to the maximum extent permitted by applicable law in each jurisdiction, with provisions for jurisdictional adaptation as detailed in our Liability Policy.
|
Liability limitations apply to the maximum extent permitted by applicable law in each jurisdiction, with provisions for jurisdictional adaptation as detailed in our Liability Policy.
|
||||||
|
|
||||||
## 12. INDEMNIFICATION
|
## 12. INDEMNIFICATION
|
||||||
|
|
||||||
### 12.1 Reference to Comprehensive Indemnification
|
### 12.1. Reference to Comprehensive Indemnification
|
||||||
|
|
||||||
Detailed indemnification obligations, procedures, and scope are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.
|
Detailed indemnification obligations, procedures, and scope are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
### 12.2 Summary of Indemnification
|
### 12.2. Summary of Indemnification
|
||||||
|
|
||||||
Users agree to indemnify nhcarrigan for claims arising from their use of Services, breach of terms, legal violations, and infringement of third-party rights, subject to the detailed provisions in our Indemnification Policy.
|
Users agree to indemnify NHCarrigan for claims arising from their use of Services, breach of terms, legal violations, and infringement of third-party rights, subject to the detailed provisions in our Indemnification Policy.
|
||||||
|
|
||||||
## 13. TERMINATION
|
## 13. TERMINATION
|
||||||
|
|
||||||
### 13.1 Termination by Either Party
|
### 13.1. Termination by Either Party
|
||||||
|
|
||||||
Either party may terminate these Terms at any time:
|
Either party may terminate these Terms at any time:
|
||||||
|
|
||||||
@@ -322,7 +322,7 @@ Either party may terminate these Terms at any time:
|
|||||||
|
|
||||||
**(b)** We may terminate immediately with or without cause or notice.
|
**(b)** We may terminate immediately with or without cause or notice.
|
||||||
|
|
||||||
### 13.2 Effect of Termination
|
### 13.2. Effect of Termination
|
||||||
|
|
||||||
Upon termination:
|
Upon termination:
|
||||||
|
|
||||||
@@ -332,72 +332,68 @@ Upon termination:
|
|||||||
|
|
||||||
**(c)** Sections that by their nature should survive termination shall remain in effect.
|
**(c)** Sections that by their nature should survive termination shall remain in effect.
|
||||||
|
|
||||||
### 13.3 Survival
|
### 13.3. Survival
|
||||||
|
|
||||||
The following sections shall survive termination of these Terms: Definitions, User-Generated Content, Disclaimers, Limitation of Liability, Indemnification, Governing Law, and any other sections that by their nature should survive.
|
The following sections shall survive termination of these Terms: Definitions, User-Generated Content, Disclaimers, Limitation of Liability, Indemnification, Governing Law, and any other sections that by their nature should survive.
|
||||||
|
|
||||||
## 14. GOVERNING LAW AND DISPUTE RESOLUTION
|
## 14. GOVERNING LAW AND DISPUTE RESOLUTION
|
||||||
|
|
||||||
### 14.1 Governing Law
|
### 14.1. Governing Law
|
||||||
|
|
||||||
These Terms shall be governed by and construed in accordance with the laws of Washington State, United States, without regard to its conflict of law principles.
|
These Terms shall be governed by and construed in accordance with the laws of Washington State, United States, without regard to its conflict of law principles.
|
||||||
|
|
||||||
### 14.2 Jurisdiction and Venue
|
### 14.2. Jurisdiction and Venue
|
||||||
|
|
||||||
Any legal action or proceeding arising out of or relating to these Terms shall be brought exclusively in the federal or state courts located in Washington State, United States. You consent to the jurisdiction of such courts.
|
Any legal action or proceeding arising out of or relating to these Terms shall be brought exclusively in the federal or state courts located in Washington State, United States. You consent to the jurisdiction of such courts.
|
||||||
|
|
||||||
### 14.3 Dispute Resolution
|
### 14.3. Dispute Resolution
|
||||||
|
|
||||||
Before initiating any formal legal proceedings, the parties agree to attempt to resolve any disputes through good faith negotiations for a period of at least thirty (30) days.
|
Before initiating any formal legal proceedings, the parties agree to attempt to resolve any disputes through good faith negotiations for a period of at least thirty (30) days.
|
||||||
|
|
||||||
### 14.4 Class Action Waiver
|
### 14.4. Class Action Waiver
|
||||||
|
|
||||||
You agree that any disputes shall be resolved on an individual basis and not as part of a class action, collective action, or representative proceeding.
|
You agree that any disputes shall be resolved on an individual basis and not as part of a class action, collective action, or representative proceeding.
|
||||||
|
|
||||||
## 15. GENERAL PROVISIONS
|
## 15. GENERAL PROVISIONS
|
||||||
|
|
||||||
### 15.1 Entire Agreement
|
### 15.1. Entire Agreement
|
||||||
|
|
||||||
These Terms, together with our Privacy Policy and any other legal notices published by us, constitute the complete and exclusive agreement between you and us regarding your use of the Services.
|
These Terms, together with our Privacy Policy and any other legal notices published by us, constitute the complete and exclusive agreement between you and us regarding your use of the Services.
|
||||||
|
|
||||||
### 15.2 Severability
|
### 15.2. Severability
|
||||||
|
|
||||||
If any provision of these Terms is found to be unenforceable or invalid, such provision shall be limited or eliminated to the minimum extent necessary so that these Terms shall otherwise remain in full force and effect.
|
If any provision of these Terms is found to be unenforceable or invalid, such provision shall be limited or eliminated to the minimum extent necessary so that these Terms shall otherwise remain in full force and effect.
|
||||||
|
|
||||||
### 15.3 Assignment
|
### 15.3. Assignment
|
||||||
|
|
||||||
You may not assign or transfer these Terms or your rights hereunder without our prior written consent. We may assign these Terms without restriction.
|
You may not assign or transfer these Terms or your rights hereunder without our prior written consent. We may assign these Terms without restriction.
|
||||||
|
|
||||||
### 15.4 No Waiver
|
### 15.4. No Waiver
|
||||||
|
|
||||||
Our failure to enforce any provision of these Terms shall not be construed as a waiver of such provision or our right to enforce it in the future.
|
Our failure to enforce any provision of these Terms shall not be construed as a waiver of such provision or our right to enforce it in the future.
|
||||||
|
|
||||||
### 15.5 Electronic Communications
|
### 15.5. Electronic Communications
|
||||||
|
|
||||||
You consent to receive communications from us electronically, and you agree that all agreements, notices, and other communications satisfy any legal requirement that such communications be in writing.
|
You consent to receive communications from us electronically, and you agree that all agreements, notices, and other communications satisfy any legal requirement that such communications be in writing.
|
||||||
|
|
||||||
## 16. CONTACT INFORMATION
|
## 16. CONTACT INFORMATION
|
||||||
|
|
||||||
### 16.1 General Inquiries
|
### 16.1. General Inquiries
|
||||||
|
|
||||||
For questions about these Terms or our Services, please contact us at:
|
For questions about these Terms or our Services, please contact us at:
|
||||||
|
|
||||||
**Email:** terms@nhcarrigan.com
|
**Email:** terms@nhcarrigan.com
|
||||||
|
|
||||||
### 16.2 Legal Notices
|
### 16.2. Legal Notices
|
||||||
|
|
||||||
All legal notices and formal communications should be sent to:
|
All legal notices and formal communications should be sent to:
|
||||||
|
|
||||||
**Email:** legal@nhcarrigan.com
|
**Email:** legal@nhcarrigan.com
|
||||||
|
|
||||||
### 16.3 Business Hours
|
### 16.3. Business Hours
|
||||||
|
|
||||||
We endeavour to respond to all inquiries within forty-eight (48) hours during normal business hours (Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time).
|
We endeavour to respond to all inquiries within forty-eight (48) hours during normal business hours (Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time).
|
||||||
|
|
||||||
**Last Updated:** 15 September 2025
|
|
||||||
|
|
||||||
**Effective Date:** 15 September 2025
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*These Terms of Service are governed by the laws of Washington State, United States. By using our Services, you acknowledge that you have read and understood these Terms and agree to be bound by them.*
|
*These Terms of Service are governed by the laws of Washington State, United States. By using our Services, you acknowledge that you have read and understood these Terms and agree to be bound by them.*
|
||||||
|
|||||||
@@ -2,43 +2,148 @@
|
|||||||
title: 00. Frequently Asked Questions
|
title: 00. Frequently Asked Questions
|
||||||
---
|
---
|
||||||
|
|
||||||
This page outlines some of the frequently asked questions we see.
|
**PROVIDING ANSWERS TO FREQUENTLY ASKED QUESTIONS REGARDING THE MENTORSHIP PROGRAMME**
|
||||||
|
|
||||||
## Does the mentorship programme cost anything?
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
Nope! We offer this programme entirely for free. You *may* have to pay for things like hosting to deploy your app, but you will do that directly - we do not collect any tuition or academic fees.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
That being said, if you would like to [donate so we can continue offering this free programme](https://donate.nhcarrigan.com/) we would greatly appreciate it!
|
This Frequently Asked Questions Documentation (hereinafter referred to as "the FAQ") provides answers to common questions regarding our Mentorship Programme. This FAQ operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
## Why does Naomi take so long to respond?
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
We do our best to respond as quickly as possible. Please understand that Naomi does this completely for free, and works multiple paid jobs to cover her expenses.
|
This FAQ addresses common questions and concerns regarding programme participation, expectations, and procedures. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
As such, this means she is very busy and can be slow to respond. If we have not responded to you within 3 days, please feel free to ping us with a gentle reminder. Repeatedly pinging us with a greater frequency than every three days may result in sanctions.
|
**IMPORTANT: This FAQ supplements but does not replace our comprehensive Mentorship Programme Terms and Conditions. All programme participants are required to familiarise themselves with and comply with all applicable policies.**
|
||||||
|
|
||||||
Thank you for your patience and understanding.
|
## 2. PROGRAMME COST AND FINANCIAL MATTERS
|
||||||
|
|
||||||
## What if I change my mind?
|
### 2.1. Programme Fees
|
||||||
|
|
||||||
You are welcome to leave the mentorship programme at any time! We are not going to hold you hostage, or charge you fines. We only ask that you let us know you wish to drop out and why, so we can track feedback and graduation rates.
|
**Question: Does the mentorship programme cost anything?**
|
||||||
|
|
||||||
We promise not to pressure you to stay, regardless of the reason you choose to drop out.
|
**Answer:** No. Our Mentorship Programme is offered entirely free of charge. We do not collect tuition fees, academic fees, or any other programme-related charges.
|
||||||
|
|
||||||
## I do not want to drop out, but I have a life situation going on...
|
**Additional Costs:**
|
||||||
|
- Participants may incur costs for third-party services such as hosting for application deployment
|
||||||
|
- All such costs are paid directly to third-party service providers
|
||||||
|
- Our organisation does not collect, process, or receive any payments related to these third-party services
|
||||||
|
|
||||||
Totally acceptable! We do not have activity requirements. If you need to take a break to address other circumstances, just let us know (so we don't ping you with reminders)!
|
**Voluntary Donations:**
|
||||||
|
- We welcome voluntary donations to support programme operations
|
||||||
|
- Donations are entirely optional and do not affect programme participation or outcomes
|
||||||
|
- Information about donation options is available at: [https://donate.nhcarrigan.com/](https://donate.nhcarrigan.com/)
|
||||||
|
|
||||||
## Will you kick us out at all?
|
## 3. COMMUNICATION AND RESPONSE TIMELINES
|
||||||
|
|
||||||
Yes, but expulsion is done only under specific circumstances:
|
### 3.1. Response Time Expectations
|
||||||
|
|
||||||
1. You completely ghost us - you have not communicated the need for a break, and are not responding to our messages. If you disappear for two weeks or more without informing us, we will have to remove you to make room for someone who is ready to commit.
|
**Question: Why does Naomi take so long to respond?**
|
||||||
2. You violate our [Code of Conduct](https://docs.nhcarrigan.com/community/coc/). Sorry, but our rules foster a safe and inclusive learning environment, and if you choose not to obey them we cannot have you in our community spaces.
|
|
||||||
3. You engage in malicious behaviour. If you intentionally push malware or viruses to your repository, or you design a project that actively harms people, we will not support that and you will be expelled.
|
|
||||||
|
|
||||||
## What if I have a question not covered here?
|
**Answer:** We strive to respond to all communications as promptly as possible. However, please understand that:
|
||||||
|
|
||||||
Ping us in #mentee-chat! We are always happy to answer questions!
|
- The Mentorship Programme is provided on a voluntary basis without compensation
|
||||||
|
- Programme leadership maintains multiple paid employment positions to cover personal expenses
|
||||||
|
- Response times may vary based on workload, availability, and other commitments
|
||||||
|
|
||||||
|
**Response Time Guidelines:**
|
||||||
|
- If you have not received a response within three (3) business days, you may send a gentle reminder
|
||||||
|
- Repeated communications at intervals of less than three (3) days may result in disciplinary action
|
||||||
|
- We appreciate your patience and understanding regarding response timelines
|
||||||
|
|
||||||
|
## 4. PROGRAMME WITHDRAWAL AND DISCONTINUATION
|
||||||
|
|
||||||
|
### 4.1. Voluntary Withdrawal
|
||||||
|
|
||||||
|
**Question: What if I change my mind?**
|
||||||
|
|
||||||
|
**Answer:** Participants may withdraw from the Mentorship Programme at any time without penalty or obligation.
|
||||||
|
|
||||||
|
**Withdrawal Procedures:**
|
||||||
|
- Participants must notify programme leadership of their intent to withdraw
|
||||||
|
- We request that participants provide a brief explanation for withdrawal to assist with programme improvement
|
||||||
|
- No fees, fines, or penalties apply to voluntary withdrawal
|
||||||
|
- Programme leadership will not pressure participants to remain in the programme
|
||||||
|
|
||||||
|
### 4.2. Temporary Breaks and Life Circumstances
|
||||||
|
|
||||||
|
**Question: I do not want to drop out, but I have a life situation going on...**
|
||||||
|
|
||||||
|
**Answer:** Temporary breaks from programme activities are acceptable and accommodated.
|
||||||
|
|
||||||
|
**Break Procedures:**
|
||||||
|
- Participants may request temporary breaks to address personal circumstances
|
||||||
|
- No activity requirements are enforced during approved breaks
|
||||||
|
- Participants must notify programme leadership of break requests to avoid unnecessary communications
|
||||||
|
- Programme leadership will respect break periods and adjust communications accordingly
|
||||||
|
|
||||||
|
## 5. PROGRAMME EXPULSION AND TERMINATION
|
||||||
|
|
||||||
|
### 5.1. Expulsion Circumstances
|
||||||
|
|
||||||
|
**Question: Will you kick us out at all?**
|
||||||
|
|
||||||
|
**Answer:** Programme participation may be terminated under specific circumstances as outlined in our Mentorship Programme Terms and Conditions.
|
||||||
|
|
||||||
|
**Grounds for Expulsion:**
|
||||||
|
|
||||||
|
**5.1.1 Inactivity and Non-Communication:**
|
||||||
|
- Failure to communicate for a period of two (2) weeks or more without prior notification
|
||||||
|
- Complete absence of response to programme communications
|
||||||
|
- Failure to notify programme leadership of breaks or absences
|
||||||
|
- Expulsion may occur to make programme capacity available for committed participants
|
||||||
|
|
||||||
|
**5.1.2 Code of Conduct Violations:**
|
||||||
|
- Violation of our [Community Code of Conduct](/community/coc)
|
||||||
|
- Failure to comply with community rules and standards
|
||||||
|
- Behaviour that compromises the safety and inclusivity of our learning environment
|
||||||
|
- Expulsion is necessary to maintain programme integrity and community safety
|
||||||
|
|
||||||
|
**5.1.3 Malicious Behaviour:**
|
||||||
|
- Intentional introduction of malware, viruses, or malicious code to programme repositories
|
||||||
|
- Development of projects designed to actively harm individuals or groups
|
||||||
|
- Any behaviour that poses security risks or legal liability
|
||||||
|
- Expulsion is necessary to protect programme participants and our organisation
|
||||||
|
|
||||||
|
### 5.2. Expulsion Procedures
|
||||||
|
|
||||||
|
All expulsion decisions are made in accordance with our Mentorship Programme Terms and Conditions and Community Code of Conduct. Participants subject to expulsion will receive appropriate notice and may access our appeals process as outlined in our [Appeals Process](/community/appeal).
|
||||||
|
|
||||||
|
## 6. ADDITIONAL QUESTIONS AND SUPPORT
|
||||||
|
|
||||||
|
### 6.1. Unanswered Questions
|
||||||
|
|
||||||
|
**Question: What if I have a question not covered here?**
|
||||||
|
|
||||||
|
**Answer:** For questions not addressed in this FAQ:
|
||||||
|
|
||||||
|
- Contact programme leadership through the designated #mentee-chat channel in our Discord community
|
||||||
|
- Programme leadership is available to answer questions and provide clarification
|
||||||
|
- Additional information is available in our comprehensive [Mentorship Programme Terms and Conditions](/about/mentorship)
|
||||||
|
|
||||||
|
## 7. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 7.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 7.2. Programme Disclaimer
|
||||||
|
|
||||||
|
This FAQ provides general information about our Mentorship Programme. However:
|
||||||
|
|
||||||
|
- Programme terms, conditions, and procedures may be modified at any time
|
||||||
|
- This FAQ does not create contractual obligations beyond those set forth in our formal programme terms
|
||||||
|
- Programme leadership reserves the right to make decisions regarding programme participation based on individual circumstances
|
||||||
|
|
||||||
|
## 8. CONCLUSION
|
||||||
|
|
||||||
|
This FAQ addresses common questions regarding our Mentorship Programme. For comprehensive programme terms, conditions, and requirements, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
All programme participants are expected to familiarise themselves with and comply with all applicable policies and procedures. Questions about programme participation should be directed to programme leadership through designated communication channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about the Mentorship Programme or to suggest improvements, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,27 +2,135 @@
|
|||||||
title: 01. Onboarding
|
title: 01. Onboarding
|
||||||
---
|
---
|
||||||
|
|
||||||
Once your application has been reviewed and accepted, you will receive an email confirmation. You MUST reply to this confirmation with your GitHub username.
|
**ESTABLISHING ONBOARDING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
:::caution
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
If you do not respond to the confirmation email with your GitHub username, we will not be able to complete your onboarding.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Discord
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
You will need to join our [Discord community](https://chat.nhcarrigan.com/). This is where the bulk of our planning, coaching, and conversation will happen.
|
This Onboarding Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for participants accepted into our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
When you join, ping Naomi in the general chat channel and request the mentorship role. She will grant you this role, which allows you to access the necessary channels.
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
## GitHub
|
This Documentation applies to all individuals who have been accepted into our Mentorship Programme. All participants must complete the onboarding procedures set forth in this Documentation to gain full programme access.
|
||||||
|
|
||||||
:::caution
|
**IMPORTANT: Failure to complete onboarding procedures within specified timeframes may result in withdrawal of programme acceptance and forfeiture of programme participation opportunities.**
|
||||||
The repository we provide you is ONLY for your flagship project. You should NOT commit any other code, such as practise projects or leetcode solutions. This is the repository you will be listing on your resume for job applications, so you want it to be you at your best!
|
|
||||||
:::
|
|
||||||
|
|
||||||
You will receive an invite to a dedicated repository under this organisation to hold the code for your flagship project. You will need to accept this invite within 7 days, or it will expire.
|
## 2. APPLICATION ACCEPTANCE AND CONFIRMATION
|
||||||
|
|
||||||
You will have maintainer access to your repository, so you can configure various settings like workflows and branch protections. You will not have access to destructive settings.
|
### 2.1. Acceptance Notification
|
||||||
|
|
||||||
|
Upon review and acceptance of your application, you will receive an email confirmation of your acceptance into the Mentorship Programme.
|
||||||
|
|
||||||
|
### 2.2. Required Response
|
||||||
|
|
||||||
|
**Mandatory Requirement:** You MUST reply to the acceptance confirmation email with your GitHub username.
|
||||||
|
|
||||||
|
**Consequences of Non-Compliance:**
|
||||||
|
- Failure to respond with your GitHub username will prevent completion of onboarding procedures
|
||||||
|
- Programme access cannot be granted without GitHub account information
|
||||||
|
- Programme acceptance may be withdrawn if required information is not provided within reasonable timeframes
|
||||||
|
|
||||||
|
## 3. DISCORD COMMUNITY ACCESS
|
||||||
|
|
||||||
|
### 3.1. Discord Community Requirement
|
||||||
|
|
||||||
|
All programme participants must join our [Discord community](https://chat.nhcarrigan.com/) to access programme resources, communications, and support.
|
||||||
|
|
||||||
|
### 3.2. Discord Community Purpose
|
||||||
|
|
||||||
|
The Discord community serves as the primary platform for:
|
||||||
|
- Programme planning and coordination
|
||||||
|
- Coaching sessions and mentorship activities
|
||||||
|
- Participant communication and collaboration
|
||||||
|
- Resource sharing and programme announcements
|
||||||
|
|
||||||
|
### 3.3. Role Assignment Procedures
|
||||||
|
|
||||||
|
**Role Request Process:**
|
||||||
|
1. Join the Discord community using the provided invitation link
|
||||||
|
2. Navigate to the general chat channel
|
||||||
|
3. Send a direct message or mention to Naomi requesting the mentorship role
|
||||||
|
4. Programme leadership will grant the mentorship role upon verification
|
||||||
|
5. The mentorship role provides access to programme-specific channels and resources
|
||||||
|
|
||||||
|
## 4. GITHUB REPOSITORY ACCESS
|
||||||
|
|
||||||
|
### 4.1. Repository Purpose and Restrictions
|
||||||
|
|
||||||
|
**Repository Usage Limitations:**
|
||||||
|
|
||||||
|
**IMPORTANT: The repository provided to programme participants is designated EXCLUSIVELY for flagship project development. The following restrictions apply:**
|
||||||
|
|
||||||
|
- **Prohibited Content:** Participants must NOT commit practice projects, LeetCode solutions, or any code unrelated to the flagship project
|
||||||
|
- **Resume Portfolio:** This repository will be listed on resumes for job applications
|
||||||
|
- **Quality Standards:** Only high-quality, professional code appropriate for portfolio presentation should be committed
|
||||||
|
- **Violation Consequences:** Violation of repository usage restrictions may result in disciplinary action, including potential programme expulsion
|
||||||
|
|
||||||
|
### 4.2. Repository Invitation and Acceptance
|
||||||
|
|
||||||
|
**Invitation Process:**
|
||||||
|
- Programme participants will receive an invitation to a dedicated repository under our organisation
|
||||||
|
- The repository is designated for flagship project code storage and development
|
||||||
|
- Participants must accept the repository invitation within seven (7) days of receipt
|
||||||
|
- Invitations that are not accepted within seven (7) days will expire and may require re-invitation
|
||||||
|
|
||||||
|
### 4.3. Repository Access and Permissions
|
||||||
|
|
||||||
|
**Access Level:**
|
||||||
|
- Participants receive maintainer-level access to their designated repository
|
||||||
|
- Maintainer access permits configuration of repository settings, including:
|
||||||
|
- Workflow configurations
|
||||||
|
- Branch protection rules
|
||||||
|
- Repository settings and preferences
|
||||||
|
|
||||||
|
**Access Restrictions:**
|
||||||
|
- Participants do not have access to destructive repository settings
|
||||||
|
- Certain administrative functions remain restricted to organisation administrators
|
||||||
|
- Access levels are designed to balance participant autonomy with organisational security
|
||||||
|
|
||||||
|
## 5. ONBOARDING COMPLETION
|
||||||
|
|
||||||
|
### 5.1. Completion Requirements
|
||||||
|
|
||||||
|
Onboarding is considered complete when:
|
||||||
|
- Acceptance confirmation email has been responded to with GitHub username
|
||||||
|
- Discord community membership has been established
|
||||||
|
- Mentorship role has been assigned in Discord
|
||||||
|
- GitHub repository invitation has been accepted
|
||||||
|
- All required information has been provided to programme leadership
|
||||||
|
|
||||||
|
### 5.2. Programme Access
|
||||||
|
|
||||||
|
Upon completion of onboarding procedures, participants gain full access to:
|
||||||
|
- Programme-specific Discord channels
|
||||||
|
- GitHub repository for flagship project development
|
||||||
|
- Programme resources and documentation
|
||||||
|
- Mentorship sessions and coaching activities
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Onboarding Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes mandatory onboarding procedures. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify onboarding procedures at any time
|
||||||
|
- Failure to complete onboarding within specified timeframes may result in programme access delays or withdrawal
|
||||||
|
- Programme leadership is not responsible for technical issues preventing onboarding completion beyond our reasonable control
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Onboarding Documentation establishes the procedures and requirements for participants accepted into our Mentorship Programme. All participants must complete these procedures to gain full programme access.
|
||||||
|
|
||||||
|
Questions about onboarding procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about onboarding procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -1,33 +1,144 @@
|
|||||||
---
|
---
|
||||||
title: 02. Goal Setting
|
title: 02. Goal Setting
|
||||||
---
|
---
|
||||||
After your onboarding is complete, you will need to begin your goal-setting. Create a thread in the #goal-setting forum on our Discord, and name it as follows:
|
|
||||||
|
**ESTABLISHING GOAL-SETTING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Goal-Setting Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for goal-setting activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all participants in our Mentorship Programme following completion of onboarding procedures. All participants must complete the goal-setting process set forth in this Documentation to proceed with programme activities.
|
||||||
|
|
||||||
|
**IMPORTANT: Goal-setting is a mandatory component of programme participation. Failure to complete goal-setting procedures may delay or prevent progression to project planning and development stages.**
|
||||||
|
|
||||||
|
## 2. GOAL-SETTING INITIATION
|
||||||
|
|
||||||
|
### 2.1. Timing and Prerequisites
|
||||||
|
|
||||||
|
Goal-setting procedures must be initiated following completion of onboarding procedures as outlined in our [Onboarding Documentation](/mentorship/01-onboarding).
|
||||||
|
|
||||||
|
### 2.2. Goal-Setting Forum Post Creation
|
||||||
|
|
||||||
|
**Required Action:** Create a thread in the #goal-setting forum channel on our Discord community.
|
||||||
|
|
||||||
|
**Thread Naming Convention:**
|
||||||
|
```markdown
|
||||||
|
<full name> - Goals
|
||||||
|
```
|
||||||
|
|
||||||
|
**Naming Requirements:**
|
||||||
|
- Use your full legal name or preferred full name
|
||||||
|
- Follow the exact format: "[Full Name] - Goals"
|
||||||
|
- Ensure consistency with other programme documentation
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
<full name> - Goals
|
<full name> - Goals
|
||||||
```
|
```
|
||||||
|
|
||||||
In your initial post, you will want to outline the following information:
|
### 2.3. Required Information Disclosure
|
||||||
|
|
||||||
- The type of role you want for your career (e.g. full-stack dev, front-end dev, mobile dev, game dev)
|
**Mandatory Information:** Your initial goal-setting post must include the following information:
|
||||||
- Your current learning state (what languages you know, what projects you have built)
|
|
||||||
- Your interests outside of coding (hobbies, passions, etc)
|
|
||||||
|
|
||||||
Our team will use this information as the starting point for your road map. We may ask some follow up questions.
|
**2.3.1 Career Objectives:**
|
||||||
|
- Specify the type of role you are pursuing for your career
|
||||||
|
- Examples include: full-stack developer, front-end developer, mobile developer, game developer
|
||||||
|
- Provide clarity regarding your professional aspirations and career direction
|
||||||
|
|
||||||
## Road Map
|
**2.3.2 Current Learning State:**
|
||||||
|
- Document your current technical knowledge and skills
|
||||||
|
- List programming languages, frameworks, and technologies with which you have experience
|
||||||
|
- Describe projects you have previously built or contributed to
|
||||||
|
- Provide an honest assessment of your current skill level
|
||||||
|
|
||||||
To finalise your goal setting conversation, we will provide a 12-week road map to outline your learning and completion of your flagship project. We will ask for your confirmation of the road map.
|
**2.3.3 Personal Interests:**
|
||||||
|
- Describe your interests, hobbies, and passions outside of coding
|
||||||
|
- This information assists in aligning programme activities with your personal motivations
|
||||||
|
- Helps programme leadership tailor mentorship approaches to your individual needs
|
||||||
|
|
||||||
Be sure to take the time to read it thoroughly, and assess whether it seems achievable, aligns with your goals for the programme, and incorporates your interests.
|
### 2.4. Follow-Up Questions and Clarification
|
||||||
|
|
||||||
:::note
|
Programme leadership may request additional information or clarification through follow-up questions. Participants are expected to respond promptly and thoroughly to facilitate effective goal-setting and roadmap development.
|
||||||
Plans must be solid, but reactions flexible.
|
|
||||||
:::
|
|
||||||
|
|
||||||
The 12-week road map is not set in stone - we will adapt to changes in your situation, timeline requirements, etc. It merely gives us the scaffolding we need to best guide your journey.
|
## 3. ROADMAP DEVELOPMENT AND CONFIRMATION
|
||||||
|
|
||||||
Once you sign off on the road map, we will be ready to move to the project planning stage.
|
### 3.1. Twelve-Week Roadmap Provision
|
||||||
|
|
||||||
|
To finalise the goal-setting process, programme leadership will provide a comprehensive twelve (12) week roadmap outlining:
|
||||||
|
|
||||||
|
- Learning objectives and milestones
|
||||||
|
- Flagship project development timeline
|
||||||
|
- Skill development activities and resources
|
||||||
|
- Programme progression expectations
|
||||||
|
|
||||||
|
### 3.2. Roadmap Review and Assessment
|
||||||
|
|
||||||
|
**Participant Responsibilities:**
|
||||||
|
- Review the provided roadmap thoroughly and completely
|
||||||
|
- Assess whether the roadmap appears achievable given your circumstances
|
||||||
|
- Evaluate whether the roadmap aligns with your programme goals
|
||||||
|
- Verify that the roadmap incorporates your stated interests and preferences
|
||||||
|
|
||||||
|
**Review Considerations:**
|
||||||
|
- Timeline feasibility given your availability and commitments
|
||||||
|
- Alignment with your career objectives and learning goals
|
||||||
|
- Incorporation of your interests and motivations
|
||||||
|
- Realistic assessment of your current skill level and learning capacity
|
||||||
|
|
||||||
|
### 3.3. Roadmap Flexibility and Adaptation
|
||||||
|
|
||||||
|
**Flexibility Principle:**
|
||||||
|
- Roadmaps are designed to provide structure and guidance, not rigid constraints
|
||||||
|
- Programme leadership will adapt roadmaps to accommodate changes in:
|
||||||
|
- Participant circumstances and availability
|
||||||
|
- Timeline requirements and constraints
|
||||||
|
- Learning progress and skill development
|
||||||
|
- Project scope and complexity adjustments
|
||||||
|
|
||||||
|
**Adaptation Process:**
|
||||||
|
- Participants may request roadmap modifications as circumstances change
|
||||||
|
- Programme leadership will work collaboratively to adjust roadmaps when necessary
|
||||||
|
- Regular check-ins provide opportunities for roadmap refinement
|
||||||
|
|
||||||
|
### 3.4. Roadmap Confirmation
|
||||||
|
|
||||||
|
**Confirmation Requirement:**
|
||||||
|
- Participants must provide explicit confirmation of roadmap acceptance
|
||||||
|
- Confirmation indicates agreement with the proposed learning and development plan
|
||||||
|
- Roadmap confirmation is required before progression to project planning stages
|
||||||
|
|
||||||
|
**Post-Confirmation:**
|
||||||
|
- Upon roadmap confirmation, participants are ready to proceed to project planning
|
||||||
|
- Project planning procedures are outlined in our [Project Planning Documentation](/mentorship/03-project-plan)
|
||||||
|
|
||||||
|
## 4. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 4.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 4.2. Goal-Setting Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes goal-setting procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify goal-setting procedures at any time
|
||||||
|
- Roadmaps are provided as guidance and do not guarantee specific outcomes or achievements
|
||||||
|
- Programme leadership is not responsible for participants' ability to achieve roadmap objectives
|
||||||
|
- Individual results may vary based on participant effort, circumstances, and other factors
|
||||||
|
|
||||||
|
## 5. CONCLUSION
|
||||||
|
|
||||||
|
This Goal-Setting Documentation establishes the procedures and requirements for goal-setting activities within our Mentorship Programme. All participants must complete these procedures to progress to project planning and development stages.
|
||||||
|
|
||||||
|
Questions about goal-setting procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about goal-setting procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,15 +2,72 @@
|
|||||||
title: 03. Project Planning
|
title: 03. Project Planning
|
||||||
---
|
---
|
||||||
|
|
||||||
Once your goals are set, we will begin iterating on your flagship project. Create a post in the #project-plan forum channel, using the same naming convention:
|
**ESTABLISHING PROJECT PLANNING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Project Planning Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for flagship project planning within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all participants in our Mentorship Programme following completion of goal-setting procedures. All participants must complete the project planning process set forth in this Documentation to proceed with flagship project development.
|
||||||
|
|
||||||
|
**IMPORTANT: Project planning is a mandatory component of programme participation. Failure to complete project planning procedures may delay or prevent progression to project development stages.**
|
||||||
|
|
||||||
|
## 2. PROJECT PLANNING INITIATION
|
||||||
|
|
||||||
|
### 2.1. Timing and Prerequisites
|
||||||
|
|
||||||
|
Project planning procedures must be initiated following completion of goal-setting procedures and roadmap confirmation as outlined in our [Goal-Setting Documentation](/mentorship/02-goal-setting).
|
||||||
|
|
||||||
|
### 2.2. Project Planning Forum Post Creation
|
||||||
|
|
||||||
|
**Required Action:** Create a post in the #project-plan forum channel on our Discord community.
|
||||||
|
|
||||||
|
**Post Naming Convention:**
|
||||||
|
```markdown
|
||||||
|
<full name> - Project Plan
|
||||||
|
```
|
||||||
|
|
||||||
|
**Naming Requirements:**
|
||||||
|
- Use your full legal name or preferred full name
|
||||||
|
- Follow the exact format: "[Full Name] - Project Plan"
|
||||||
|
- Ensure consistency with goal-setting documentation
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
<full name> - Project Plan
|
<full name> - Project Plan
|
||||||
```
|
```
|
||||||
|
|
||||||
In your post, you want to provide as much detail as you have about your project idea. If you do not have an idea yet, that is okay! Create your post with something like "I need help brainstorming a project idea". We will gladly work with you to find a project that furthers your goals and aligns with your interests.
|
### 2.3. Project Idea Documentation
|
||||||
|
|
||||||
Once your post is created, our team will work with you to flesh out and polish the idea into something refined and ready for work. You should end up with a project plan like:
|
**Required Information:**
|
||||||
|
- Provide as much detail as possible regarding your flagship project idea
|
||||||
|
- Include project objectives, features, and technical requirements
|
||||||
|
- Describe how the project aligns with your career goals and learning objectives
|
||||||
|
- Explain how the project incorporates your personal interests
|
||||||
|
|
||||||
|
**Project Idea Assistance:**
|
||||||
|
- If you do not yet have a project idea, create your post with a statement such as: "I need help brainstorming a project idea"
|
||||||
|
- Programme leadership will work collaboratively with you to develop a project concept
|
||||||
|
- Project ideas will be evaluated for alignment with your goals and programme objectives
|
||||||
|
- Programme leadership will assist in refining project ideas to ensure feasibility and educational value
|
||||||
|
|
||||||
|
## 3. PROJECT PLAN DEVELOPMENT AND REFINEMENT
|
||||||
|
|
||||||
|
### 3.1. Collaborative Development Process
|
||||||
|
|
||||||
|
Once your project planning post is created, programme leadership will work with you to:
|
||||||
|
|
||||||
|
- Flesh out and refine your project concept
|
||||||
|
- Develop comprehensive project specifications
|
||||||
|
- Establish technical requirements and architecture considerations
|
||||||
|
- Create a detailed project plan ready for development work
|
||||||
|
|
||||||
|
### 3.2. Project Plan Example
|
||||||
|
|
||||||
|
Upon completion of the collaborative development process, you should have a comprehensive project plan. The following example illustrates the level of detail expected:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
A life task tracker app thats open source and self-hosted as well as a live version hosted on my website with user auth and such. Could have kanban boards and different views and such, and have tasks that depend on other tasks just like on a github projects board.
|
A life task tracker app thats open source and self-hosted as well as a live version hosted on my website with user auth and such. Could have kanban boards and different views and such, and have tasks that depend on other tasks just like on a github projects board.
|
||||||
@@ -21,7 +78,45 @@ At the end I could sneak some gamification elements in as an opt-in thing where
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Our team will give the final sign-off on your project plan, and you will be ready to start writing user stories!
|
### 3.3. Project Plan Approval
|
||||||
|
|
||||||
|
**Final Sign-Off:**
|
||||||
|
- Programme leadership will provide final approval of your project plan
|
||||||
|
- Approval indicates that the project plan meets programme standards and requirements
|
||||||
|
- Project plan approval is required before progression to user story development
|
||||||
|
|
||||||
|
**Post-Approval:**
|
||||||
|
- Upon project plan approval, participants are ready to proceed to user story development
|
||||||
|
- User story development procedures are outlined in our [User Stories Documentation](/mentorship/04-user-stories)
|
||||||
|
|
||||||
|
## 4. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 4.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 4.2. Project Planning Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes project planning procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify project planning procedures at any time
|
||||||
|
- Project plans are provided as guidance and do not guarantee specific project outcomes
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete projects as planned
|
||||||
|
- Individual results may vary based on participant effort, circumstances, and other factors
|
||||||
|
|
||||||
|
### 4.3. Intellectual Property Considerations
|
||||||
|
|
||||||
|
All project work completed as part of the Mentorship Programme is subject to our Mentorship Programme Terms and Conditions regarding intellectual property rights. Participants should familiarise themselves with these terms before beginning project development.
|
||||||
|
|
||||||
|
## 5. CONCLUSION
|
||||||
|
|
||||||
|
This Project Planning Documentation establishes the procedures and requirements for flagship project planning within our Mentorship Programme. All participants must complete these procedures to progress to project development stages.
|
||||||
|
|
||||||
|
Questions about project planning procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about project planning procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,23 +2,131 @@
|
|||||||
title: 04. User Stories
|
title: 04. User Stories
|
||||||
---
|
---
|
||||||
|
|
||||||
Creating user stories is a crucial step in planning your project. This helps you visualise and understand your application's requirements, broken down into digestible isolated chunks so you can maintain a smaller scope of work for each task.
|
**ESTABLISHING USER STORY DEVELOPMENT PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
Based on your project plan, you will want to create an *individual issue* on your GitHub repository for *each user story*. So, if you have 30 stories, you should have 30 issues.
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
## What is a user story?
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
A user story is an application requirement that is written from the perspective of an end user. Here are some examples:
|
This User Stories Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for user story development within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all participants in our Mentorship Programme following completion of project planning procedures. All participants must complete the user story development process set forth in this Documentation to proceed with technical breakdown and development stages.
|
||||||
|
|
||||||
|
**IMPORTANT: User story development is a mandatory component of programme participation. Failure to complete user story development procedures may delay or prevent progression to technical breakdown and development stages.**
|
||||||
|
|
||||||
|
## 2. USER STORY DEVELOPMENT REQUIREMENTS
|
||||||
|
|
||||||
|
### 2.1. Purpose and Importance
|
||||||
|
|
||||||
|
Creating user stories is a crucial step in project planning that:
|
||||||
|
|
||||||
|
- Helps visualise and understand application requirements
|
||||||
|
- Breaks down requirements into digestible, isolated components
|
||||||
|
- Maintains a smaller, manageable scope of work for each task
|
||||||
|
- Facilitates effective project management and development workflow
|
||||||
|
|
||||||
|
### 2.2. User Story Issue Creation
|
||||||
|
|
||||||
|
**Mandatory Requirement:** Based on your approved project plan, you must create an individual issue on your GitHub repository for each user story.
|
||||||
|
|
||||||
|
**Issue Creation Requirements:**
|
||||||
|
- Each user story must be created as a separate, individual Gitea issue
|
||||||
|
- If your project plan contains thirty (30) user stories, you must create thirty (30) separate issues
|
||||||
|
- Each issue must be clearly titled and contain the complete user story description
|
||||||
|
- Issues must be created in the repository designated for your flagship project
|
||||||
|
|
||||||
|
## 3. USER STORY DEFINITION AND FORMAT
|
||||||
|
|
||||||
|
### 3.1. User Story Definition
|
||||||
|
|
||||||
|
A user story is an application requirement written from the perspective of an end user. User stories follow a standard format that describes:
|
||||||
|
|
||||||
|
- The user role or persona
|
||||||
|
- The desired functionality or capability
|
||||||
|
- The value or benefit to the user
|
||||||
|
|
||||||
|
### 3.2. User Story Examples
|
||||||
|
|
||||||
|
The following examples illustrate proper user story format:
|
||||||
|
|
||||||
|
**Example 1:**
|
||||||
- As an unauthenticated user, I can see a button to go through the login or registration flows.
|
- As an unauthenticated user, I can see a button to go through the login or registration flows.
|
||||||
|
|
||||||
|
**Example 2:**
|
||||||
- As an authenticated user, I can fill out a form to schedule an appointment and select from available dates and times listed on a calendar.
|
- As an authenticated user, I can fill out a form to schedule an appointment and select from available dates and times listed on a calendar.
|
||||||
|
|
||||||
|
**Example 3:**
|
||||||
- As an administrator, I can review posts for their content and remove the ones that violate our policies.
|
- As an administrator, I can review posts for their content and remove the ones that violate our policies.
|
||||||
|
|
||||||
## Why separate issues? Can I not use a single issue with a list?
|
## 4. ISSUE SEPARATION AND WORKFLOW
|
||||||
|
|
||||||
Maintaining separate issues, or tickets, allows you to link each user story to a specific pull request. This is a common workflow, and ensures that your changes remain within the scope of a specific story.
|
### 4.1. Separate Issue Requirement
|
||||||
|
|
||||||
Once you have your user stories all logged as individual issues, ping Naomi in the #mentee-chat for a final review. If we sign off on your issues, we will move into the technical breakdown step.
|
**Question: Why separate issues? Can I not use a single issue with a list?**
|
||||||
|
|
||||||
|
**Answer:** Maintaining separate issues, or tickets, is required for the following reasons:
|
||||||
|
|
||||||
|
- **Pull Request Linking:** Each user story can be linked to a specific pull request
|
||||||
|
- **Scope Management:** Ensures that changes remain within the scope of a specific story
|
||||||
|
- **Workflow Standardisation:** Follows common industry practices for project management
|
||||||
|
- **Progress Tracking:** Facilitates accurate tracking of development progress and completion
|
||||||
|
|
||||||
|
### 4.2. Workflow Benefits
|
||||||
|
|
||||||
|
Separate issues provide:
|
||||||
|
|
||||||
|
- Clear traceability between requirements and implementation
|
||||||
|
- Better organisation and management of development tasks
|
||||||
|
- Improved collaboration and communication regarding specific features
|
||||||
|
- Enhanced ability to prioritise and schedule development work
|
||||||
|
|
||||||
|
## 5. USER STORY REVIEW AND APPROVAL
|
||||||
|
|
||||||
|
### 5.1. Review Request Process
|
||||||
|
|
||||||
|
**Required Action:** Once you have created all user stories as individual issues, you must:
|
||||||
|
|
||||||
|
- Contact programme leadership through the #mentee-chat channel in our Discord community
|
||||||
|
- Request final review of your user stories
|
||||||
|
- Provide access to your repository for review purposes
|
||||||
|
|
||||||
|
### 5.2. Review and Sign-Off
|
||||||
|
|
||||||
|
**Review Process:**
|
||||||
|
- Programme leadership will review all user stories for completeness and quality
|
||||||
|
- Feedback may be provided regarding user story format, clarity, or scope
|
||||||
|
- Programme leadership will provide sign-off when user stories meet programme standards
|
||||||
|
|
||||||
|
**Post-Approval:**
|
||||||
|
- Upon sign-off of user stories, participants are ready to proceed to technical breakdown
|
||||||
|
- Technical breakdown procedures are outlined in our [Technical Breakdown Documentation](/mentorship/05-technical-breakdown)
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. User Story Development Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes user story development procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify user story development procedures at any time
|
||||||
|
- User stories are provided as guidance and do not guarantee specific project outcomes
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete user stories as planned
|
||||||
|
- Individual results may vary based on participant effort, circumstances, and other factors
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This User Stories Documentation establishes the procedures and requirements for user story development within our Mentorship Programme. All participants must complete these procedures to progress to technical breakdown and development stages.
|
||||||
|
|
||||||
|
Questions about user story development procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about user story development procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,7 +2,37 @@
|
|||||||
title: 05. Technical Breakdown
|
title: 05. Technical Breakdown
|
||||||
---
|
---
|
||||||
|
|
||||||
Once your user stories are complete, Naomi will audit them. She may have some feedback, but generally she will sign off on them by editing the issue to include this template:
|
**ESTABLISHING TECHNICAL BREAKDOWN PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Technical Breakdown Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for technical breakdown activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all participants in our Mentorship Programme following completion of user story development procedures. All participants must complete the technical breakdown process set forth in this Documentation to proceed with development work.
|
||||||
|
|
||||||
|
**IMPORTANT: Technical breakdown is a mandatory component of programme participation. Failure to complete technical breakdown procedures may delay or prevent progression to development stages.**
|
||||||
|
|
||||||
|
## 2. TECHNICAL BREAKDOWN INITIATION
|
||||||
|
|
||||||
|
### 2.1. Timing and Prerequisites
|
||||||
|
|
||||||
|
Technical breakdown procedures must be initiated following completion of user story development and approval as outlined in our [User Stories Documentation](/mentorship/04-user-stories).
|
||||||
|
|
||||||
|
### 2.2. User Story Audit and Review
|
||||||
|
|
||||||
|
Once your user stories are complete, programme leadership will audit them. The audit process may include:
|
||||||
|
|
||||||
|
- Review of user story completeness and quality
|
||||||
|
- Feedback regarding user story format, clarity, or scope
|
||||||
|
- Sign-off when user stories meet programme standards
|
||||||
|
|
||||||
|
### 2.3. Technical Breakdown Template Provision
|
||||||
|
|
||||||
|
Programme leadership will sign off on approved user stories by editing the issue to include the technical breakdown template set forth in Section 3 of this Documentation.
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## 🎯 Acceptance Criteria
|
## 🎯 Acceptance Criteria
|
||||||
@@ -43,13 +73,63 @@ Once your user stories are complete, Naomi will audit them. She may have some fe
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This template is specifically designed to help you understand how to break down your user story into actionable components. Which means your next task is to fill it out!
|
### 2.4. Template Purpose and Requirements
|
||||||
|
|
||||||
Take your time and be as detailed as possible. Remember, the more planning you do now, the less factoring you need later.
|
**Template Purpose:**
|
||||||
|
This template is specifically designed to help participants understand how to break down user stories into actionable technical components.
|
||||||
|
|
||||||
## Example
|
**Completion Requirements:**
|
||||||
|
- Participants must fill out the technical breakdown template for each approved user story
|
||||||
|
- Template completion must be thorough and detailed
|
||||||
|
- All sections of the template must be addressed to the best of the participant's ability
|
||||||
|
- Programme leadership may provide guidance and feedback during template completion
|
||||||
|
|
||||||
Say I have a user story "As a user, I should be able to add a game to my library". I would **edit the issue body to fill in the template** like so:
|
**Planning Importance:**
|
||||||
|
- Comprehensive planning at this stage reduces the need for refactoring during development
|
||||||
|
- Detailed technical breakdown facilitates more efficient and effective development work
|
||||||
|
- Thorough planning helps identify potential challenges and dependencies early in the process
|
||||||
|
|
||||||
|
## 3. TECHNICAL BREAKDOWN TEMPLATE
|
||||||
|
|
||||||
|
### 3.1. Template Structure
|
||||||
|
|
||||||
|
The technical breakdown template includes the following sections:
|
||||||
|
|
||||||
|
**3.1.1 Acceptance Criteria:**
|
||||||
|
- Clear, testable conditions that must be met for the user story to be considered complete
|
||||||
|
- Criteria should be specific, measurable, and verifiable
|
||||||
|
|
||||||
|
**3.1.2 Technical Details:**
|
||||||
|
- Proposed implementation approach (e.g., API endpoints, UI components, database schema changes)
|
||||||
|
- Data considerations (models, validation, storage needs)
|
||||||
|
- Security and permissions requirements (authentication, role checks, access controls)
|
||||||
|
|
||||||
|
**3.1.3 Dependencies:**
|
||||||
|
- Related tickets or features that must be completed first
|
||||||
|
- External services or APIs required for implementation
|
||||||
|
- Libraries or frameworks necessary for development
|
||||||
|
|
||||||
|
**3.1.4 Testing Notes:**
|
||||||
|
- Unit tests required to cover functionality
|
||||||
|
- Integration tests needed for component interaction
|
||||||
|
- Manual QA steps for validation
|
||||||
|
|
||||||
|
**3.1.5 Additional Context:**
|
||||||
|
- Links to designs, diagrams, or documentation
|
||||||
|
- Constraints or assumptions affecting implementation
|
||||||
|
- Open questions or items requiring clarification
|
||||||
|
|
||||||
|
### 3.2. Template Format
|
||||||
|
|
||||||
|
The technical breakdown template format is as follows:
|
||||||
|
|
||||||
|
## 4. TECHNICAL BREAKDOWN EXAMPLE
|
||||||
|
|
||||||
|
### 4.1. Example User Story
|
||||||
|
|
||||||
|
The following example demonstrates proper technical breakdown completion. For a user story stating "As a user, I should be able to add a game to my library," the technical breakdown would be completed as follows:
|
||||||
|
|
||||||
|
**Required Action:** Edit the issue body to fill in the template with the following information:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
🎯 Acceptance Criteria
|
🎯 Acceptance Criteria
|
||||||
@@ -61,7 +141,7 @@ Say I have a user story "As a user, I should be able to add a game to my library
|
|||||||
⚙️ Technical Details
|
⚙️ Technical Details
|
||||||
- Proposed implementation approach:
|
- Proposed implementation approach:
|
||||||
- [ ] POST /library
|
- [ ] POST /library
|
||||||
- [ ] DELETE /library
|
- [ ] DELETE /library
|
||||||
- Data considerations:
|
- Data considerations:
|
||||||
- [ ] User model must have library property
|
- [ ] User model must have library property
|
||||||
- [ ] Library property must be array with game IDs
|
- [ ] Library property must be array with game IDs
|
||||||
@@ -91,6 +171,46 @@ Say I have a user story "As a user, I should be able to add a game to my library
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 5. TECHNICAL BREAKDOWN COMPLETION
|
||||||
|
|
||||||
|
### 5.1. Completion Requirements
|
||||||
|
|
||||||
|
Participants must complete the technical breakdown template for each approved user story. Completion includes:
|
||||||
|
|
||||||
|
- Filling out all sections of the template to the best of your ability
|
||||||
|
- Providing detailed, specific information in each section
|
||||||
|
- Identifying dependencies, testing requirements, and technical considerations
|
||||||
|
- Seeking clarification from programme leadership when needed
|
||||||
|
|
||||||
|
### 5.2. Review and Approval
|
||||||
|
|
||||||
|
Programme leadership will review completed technical breakdowns and may provide feedback or request additional information. Upon approval of technical breakdowns, participants may proceed to priority and effort assignment as outlined in our [Priority and Effort Documentation](/mentorship/06-priority-and-effort).
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Technical Breakdown Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes technical breakdown procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify technical breakdown procedures at any time
|
||||||
|
- Technical breakdowns are provided as guidance and do not guarantee specific implementation outcomes
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete technical breakdowns as planned
|
||||||
|
- Individual results may vary based on participant effort, technical knowledge, and other factors
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Technical Breakdown Documentation establishes the procedures and requirements for technical breakdown activities within our Mentorship Programme. All participants must complete these procedures to progress to development stages.
|
||||||
|
|
||||||
|
Questions about technical breakdown procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about technical breakdown procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
- [Discord](https://chat.nhcarrigan.com/)
|
- [Discord](https://chat.nhcarrigan.com/)
|
||||||
|
|||||||
@@ -2,41 +2,171 @@
|
|||||||
title: 06. Priority and Effort
|
title: 06. Priority and Effort
|
||||||
---
|
---
|
||||||
|
|
||||||
Your next step is to apply labels to your user stories that indicate the priority and effort level. These labels have NOT been created for you, so you will need to create the labels for your repository - we are not enforcing a specific naming convention, so use the labels that best align with your organisational style.
|
**ESTABLISHING PRIORITY AND EFFORT ASSIGNMENT PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
There are two things you want to have labelled on each issue: priority and effort.
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
## Priority
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
Assigning priority to your user stories is probably not what you might expect. You are not using something like "this is more fun to work on, so higher priority", or "this does not excite me so I will de-prioritise it".
|
This Priority and Effort Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for priority and effort assignment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
Instead, you will look solely at what is blocking/blocked by each issue. For example, consider these three user stories:
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
|
This Documentation applies to all participants in our Mentorship Programme following completion of technical breakdown procedures. All participants must complete the priority and effort assignment process set forth in this Documentation to proceed with development work.
|
||||||
|
|
||||||
|
**IMPORTANT: Priority and effort assignment is a mandatory component of programme participation. Failure to complete these procedures may delay or prevent progression to development stages.**
|
||||||
|
|
||||||
|
## 2. LABEL CREATION AND ASSIGNMENT
|
||||||
|
|
||||||
|
### 2.1. Label Creation Requirement
|
||||||
|
|
||||||
|
**Mandatory Action:** You must create labels for your repository to indicate priority and effort levels.
|
||||||
|
|
||||||
|
**Label Creation Requirements:**
|
||||||
|
- Labels have NOT been pre-created for your repository
|
||||||
|
- You are responsible for creating all necessary labels
|
||||||
|
- No specific naming convention is enforced
|
||||||
|
- Labels should align with your organisational style and preferences
|
||||||
|
|
||||||
|
### 2.2. Required Label Types
|
||||||
|
|
||||||
|
**Mandatory Label Categories:**
|
||||||
|
There are two (2) required label categories that must be applied to each user story issue:
|
||||||
|
|
||||||
|
1. **Priority Labels:** Indicate the relative priority of each user story
|
||||||
|
2. **Effort Labels:** Indicate the estimated effort required to complete each user story
|
||||||
|
|
||||||
|
## 3. PRIORITY ASSIGNMENT
|
||||||
|
|
||||||
|
### 3.1. Priority Assignment Principles
|
||||||
|
|
||||||
|
**Priority Assignment Methodology:**
|
||||||
|
Assigning priority to user stories is based on dependency analysis, not personal preference or interest level.
|
||||||
|
|
||||||
|
**Prohibited Priority Factors:**
|
||||||
|
Priority should NOT be assigned based on:
|
||||||
|
- Personal interest or enjoyment in working on a particular feature
|
||||||
|
- Excitement level or enthusiasm for specific functionality
|
||||||
|
- Subjective preferences or individual motivations
|
||||||
|
|
||||||
|
**Required Priority Factors:**
|
||||||
|
Priority MUST be assigned based on:
|
||||||
|
- Dependency relationships between user stories
|
||||||
|
- Blocking relationships (which stories block other stories)
|
||||||
|
- Logical sequence requirements for feature development
|
||||||
|
|
||||||
|
### 3.2. Dependency Analysis Example
|
||||||
|
|
||||||
|
Consider the following user stories for priority assignment:
|
||||||
|
|
||||||
|
**User Stories:**
|
||||||
1. As an unauthenticated user, I should be able to create an account or sign in to my existing account
|
1. As an unauthenticated user, I should be able to create an account or sign in to my existing account
|
||||||
2. As an authenticated user, I should be able to customise my profile
|
2. As an authenticated user, I should be able to customise my profile
|
||||||
3. As an authenticated user, I should be able to create a new post
|
3. As an authenticated user, I should be able to create a new post
|
||||||
4. As a user, I should be able to view someone's profile.
|
4. As a user, I should be able to view someone's profile
|
||||||
|
|
||||||
If we look at what is blocking what, user story 1 blocks stories 2 and 3! You cannot be an authenticated user if we do not provide a way to register and sign in.
|
**Dependency Analysis:**
|
||||||
|
- User story 1 blocks stories 2 and 3 (authentication is required for authenticated user features)
|
||||||
|
- User story 2 blocks story 4 (profile customisation must exist before profile viewing)
|
||||||
|
- Stories 2 and 3 do not block each other (they can be developed independently)
|
||||||
|
|
||||||
So issue 1 would be a high priority, because it blocks work on 2 and 3. But 2 and 3 do not block each other, so we could consider them both a medium priority. Issue 4 is blocked by issue 2, because it makes no sense to allow the viewing of profiles if there are no profiles to customise! Following our logic, then, issue 4 would be a low priority.
|
**Priority Assignment:**
|
||||||
|
- Issue 1: High priority (blocks multiple other stories)
|
||||||
|
- Issues 2 and 3: Medium priority (blocked by issue 1, but do not block each other)
|
||||||
|
- Issue 4: Low priority (blocked by issue 2)
|
||||||
|
|
||||||
Again, how you choose to "name" and assign priorities is up to you - the general idea is that you should be able to look at your priority labels and quickly determine what needs to be done next (because it is the highest priority).
|
### 3.3. Priority Label Requirements
|
||||||
|
|
||||||
## Effort
|
**Label Purpose:**
|
||||||
|
Priority labels should enable you to quickly determine which user stories need to be completed next based on their blocking relationships.
|
||||||
|
|
||||||
The next set of labels you need to apply involve determining the amount of effort required to complete the user story. Now, every organisation handles this differently. You may have heard of "story points" before, which are a way of indicating effort levels.
|
**Label Flexibility:**
|
||||||
|
- How you name and assign priorities is at your discretion
|
||||||
|
- Labels should clearly indicate relative priority levels
|
||||||
|
- Priority labels should facilitate efficient work planning and scheduling
|
||||||
|
|
||||||
How you choose to label and quantify effort is up to you. For this example, we will use a points system. Given our existing user stories above, we might assign the following points:
|
## 4. EFFORT ASSIGNMENT
|
||||||
|
|
||||||
1. Five points (building out an entire authentication flow is very complex).
|
### 4.1. Effort Assignment Principles
|
||||||
|
|
||||||
|
**Effort Definition:**
|
||||||
|
Effort labels indicate the estimated amount of work required to complete each user story.
|
||||||
|
|
||||||
|
**Effort Quantification Methods:**
|
||||||
|
- Different organisations use various methods for quantifying effort
|
||||||
|
- "Story points" are a common method for indicating effort levels
|
||||||
|
- You may choose any method that effectively communicates effort requirements
|
||||||
|
|
||||||
|
### 4.2. Effort Assignment Example
|
||||||
|
|
||||||
|
Using a points system, the following effort assignments might be appropriate for the example user stories:
|
||||||
|
|
||||||
|
**Effort Assignments:**
|
||||||
|
1. Five points (building out an entire authentication flow is very complex)
|
||||||
2. Three points
|
2. Three points
|
||||||
3. Three points
|
3. Three points
|
||||||
4. One point (showing a static page is less complex).
|
4. One point (showing a static page is less complex)
|
||||||
|
|
||||||
The purpose of applying these labels is to help you plan out the timeline of work. For example, if you have three high-priority tasks, but only have a few hours free on a Friday afternoon, you might consider completing the lowest-effort task because you have restricted time.
|
**Effort Label Flexibility:**
|
||||||
|
- How you label and quantify effort is at your discretion
|
||||||
|
- Effort labels should accurately reflect the relative complexity and work required
|
||||||
|
- Labels should facilitate effective work planning and time management
|
||||||
|
|
||||||
Once your priority and effort labels are applied, ping Naomi in the #mentee-chat again to discuss your decisions and categorisation. After we approve your labels, you are finally ready to start working on actual code!
|
### 4.3. Effort Label Purpose
|
||||||
|
|
||||||
|
**Planning Benefits:**
|
||||||
|
The purpose of applying effort labels is to help plan work timelines and resource allocation. For example:
|
||||||
|
|
||||||
|
- If you have three high-priority tasks but limited time available
|
||||||
|
- You might choose to complete the lowest-effort task first
|
||||||
|
- This allows for progress even when time is restricted
|
||||||
|
- Effort labels help balance priority with available time and resources
|
||||||
|
|
||||||
|
## 5. LABEL REVIEW AND APPROVAL
|
||||||
|
|
||||||
|
### 5.1. Review Request Process
|
||||||
|
|
||||||
|
**Required Action:** Once you have applied priority and effort labels to all user stories, you must:
|
||||||
|
|
||||||
|
- Contact programme leadership through the #mentee-chat channel in our Discord community
|
||||||
|
- Request review of your priority and effort assignments
|
||||||
|
- Be prepared to discuss your decisions and categorisation rationale
|
||||||
|
|
||||||
|
### 5.2. Review and Approval
|
||||||
|
|
||||||
|
**Review Process:**
|
||||||
|
- Programme leadership will review your priority and effort assignments
|
||||||
|
- Discussion may occur regarding your categorisation decisions
|
||||||
|
- Programme leadership will provide approval when labels meet programme standards
|
||||||
|
|
||||||
|
**Post-Approval:**
|
||||||
|
- Upon approval of priority and effort labels, participants are ready to begin development work
|
||||||
|
- Development work should follow the procedures outlined in our [Contributing Documentation](/dev/contributing) and [Style Guide](/dev/style)
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Priority and Effort Assignment Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes priority and effort assignment procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify these procedures at any time
|
||||||
|
- Priority and effort assignments are estimates and may change as development progresses
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete work within estimated effort levels
|
||||||
|
- Individual results may vary based on participant skill, experience, and other factors
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Priority and Effort Documentation establishes the procedures and requirements for priority and effort assignment within our Mentorship Programme. All participants must complete these procedures to progress to development stages.
|
||||||
|
|
||||||
|
Questions about priority and effort assignment procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about priority and effort assignment procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,33 +2,167 @@
|
|||||||
title: 07. Writing Code
|
title: 07. Writing Code
|
||||||
---
|
---
|
||||||
|
|
||||||
You are finally ready to start writing some code... But wait! We still have a couple of things to consider.
|
**ESTABLISHING CODE DEVELOPMENT PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
## Branching Strategy
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
As is common when you are working on a team professionally, you are **not** able to push directly to your `main` branch. Instead, you are required to create a dedicated branch for your work and make a pull request to bring your changes back into `main`.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
Each branch should be scoped to a *single* user story. This ensures that your pull requests remain in a manageable state and are not too massive to review.
|
This Writing Code Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for code development activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, Contributor Covenant, and all applicable legal protections by reference.
|
||||||
|
|
||||||
## Pull Request Reviews
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
Every pull request will require a review from Naomi. This ensures that we have eyes on all of the work you do, and can be in lockstep with you as you ship new features. We will review your code as if you were in a professional setting - so we will look at best practises, code quality, feature completeness, etc.
|
This Documentation applies to all participants in our Mentorship Programme following completion of priority and effort assignment procedures. All participants must comply with the code development procedures set forth in this Documentation.
|
||||||
|
|
||||||
Much like in a professional role, each pull request review will likely involve a bit of back-and-forth communication. Remember that this is a marathon, not a sprint, and every review comment we make is designed to help you learn and improve your skills.
|
**IMPORTANT: Code development must comply with our Style Guide, Contributor Covenant, and all applicable development standards. Failure to comply with these requirements may result in rejection of contributions or other appropriate actions.**
|
||||||
|
|
||||||
## Next Steps
|
## 2. DEVELOPMENT WORKFLOW REQUIREMENTS
|
||||||
|
|
||||||
You will want to start by scaffolding your project - add any tooling structure (e.g. a `package.json` file for Node.js projects) and configuration (e.g. `black` for a Python project).
|
### 2.1. Prerequisites
|
||||||
|
|
||||||
Then configure a CI file to run on every pull request to ensure things like your `lint`, `build`, and `test` steps all pass.
|
Before beginning code development, participants must have completed:
|
||||||
|
|
||||||
Setting all of this up NOW ensures that any code you write meets your quality requirements right out of the gate, and saves you from having to fix issues across dozens of files if you were to set up your tooling later.
|
- Goal-setting and roadmap confirmation
|
||||||
|
- Project planning and approval
|
||||||
|
- User story development and approval
|
||||||
|
- Technical breakdown completion
|
||||||
|
- Priority and effort assignment
|
||||||
|
|
||||||
## Yay! It is Coding Time!
|
### 2.2. Additional Considerations
|
||||||
|
|
||||||
You did it. You can start writing some actual code! Remember to work on a dedicated branch for each user story.
|
Before writing code, participants must consider and address the requirements set forth in Sections 3, 4, and 5 of this Documentation.
|
||||||
|
|
||||||
Commit early, commit often, push every time. The last thing you want to do is lose your hard work!
|
## 3. BRANCHING STRATEGY
|
||||||
|
|
||||||
|
### 3.1. Branch Protection Requirements
|
||||||
|
|
||||||
|
**Mandatory Requirement:** Participants are NOT permitted to push code directly to the `main` branch.
|
||||||
|
|
||||||
|
**Required Workflow:**
|
||||||
|
- Create a dedicated branch for each development task
|
||||||
|
- Make all changes on the dedicated branch
|
||||||
|
- Submit a pull request to merge changes back into `main`
|
||||||
|
- Follow standard professional development practices
|
||||||
|
|
||||||
|
### 3.2. Branch Scope Requirements
|
||||||
|
|
||||||
|
**Single User Story Scope:**
|
||||||
|
- Each branch must be scoped to a single user story
|
||||||
|
- This ensures that pull requests remain manageable in size
|
||||||
|
- Prevents pull requests from becoming too large to review effectively
|
||||||
|
- Facilitates clear tracking of work completion and progress
|
||||||
|
|
||||||
|
## 4. PULL REQUEST REVIEW PROCESS
|
||||||
|
|
||||||
|
### 4.1. Mandatory Review Requirement
|
||||||
|
|
||||||
|
**Review Requirement:**
|
||||||
|
- Every pull request requires review from programme leadership
|
||||||
|
- Reviews ensure oversight of all development work
|
||||||
|
- Reviews maintain alignment between participants and programme leadership
|
||||||
|
- Reviews facilitate continuous learning and skill development
|
||||||
|
|
||||||
|
### 4.2. Review Standards
|
||||||
|
|
||||||
|
**Professional Review Standards:**
|
||||||
|
Programme leadership will review code as if participants were working in a professional setting, evaluating:
|
||||||
|
|
||||||
|
- Best practices and industry standards
|
||||||
|
- Code quality and maintainability
|
||||||
|
- Feature completeness and functionality
|
||||||
|
- Compliance with style guides and standards
|
||||||
|
- Security considerations and best practices
|
||||||
|
|
||||||
|
### 4.3. Review Communication
|
||||||
|
|
||||||
|
**Iterative Review Process:**
|
||||||
|
- Pull request reviews typically involve back-and-forth communication
|
||||||
|
- Review comments are designed to facilitate learning and skill improvement
|
||||||
|
- Participants should view reviews as learning opportunities
|
||||||
|
- Programme leadership emphasises that development is a marathon, not a sprint
|
||||||
|
|
||||||
|
## 5. PROJECT SCAFFOLDING AND SETUP
|
||||||
|
|
||||||
|
### 5.1. Initial Project Setup
|
||||||
|
|
||||||
|
**Required Actions:**
|
||||||
|
Before writing application code, participants must:
|
||||||
|
|
||||||
|
**5.1.1 Tooling Structure:**
|
||||||
|
- Add appropriate tooling structure for the project type
|
||||||
|
- Examples include: `package.json` for Node.js projects, `requirements.txt` for Python projects
|
||||||
|
- Configure project-specific tooling and dependencies
|
||||||
|
|
||||||
|
**5.1.2 Configuration Files:**
|
||||||
|
- Add configuration files for code quality tools
|
||||||
|
- Examples include: `black` configuration for Python projects, ESLint configuration for JavaScript projects
|
||||||
|
- Ensure all configuration files are properly set up
|
||||||
|
|
||||||
|
### 5.2. Continuous Integration Setup
|
||||||
|
|
||||||
|
**CI Configuration Requirements:**
|
||||||
|
- Configure a CI file to run on every pull request
|
||||||
|
- CI must verify that the following steps pass:
|
||||||
|
- Linting checks
|
||||||
|
- Build processes
|
||||||
|
- Test execution
|
||||||
|
- CI failures must be resolved before pull request approval
|
||||||
|
|
||||||
|
### 5.3. Setup Timing Importance
|
||||||
|
|
||||||
|
**Early Setup Benefits:**
|
||||||
|
- Setting up tooling and CI early ensures code quality from the start
|
||||||
|
- Prevents the need to fix issues across dozens of files later
|
||||||
|
- Establishes quality standards before significant code is written
|
||||||
|
- Facilitates consistent code quality throughout development
|
||||||
|
|
||||||
|
## 6. CODE DEVELOPMENT
|
||||||
|
|
||||||
|
### 6.1. Development Authorization
|
||||||
|
|
||||||
|
Upon completion of project scaffolding and setup, participants are authorised to begin writing code for their flagship project.
|
||||||
|
|
||||||
|
### 6.2. Development Requirements
|
||||||
|
|
||||||
|
**Branch Requirements:**
|
||||||
|
- Work must be performed on dedicated branches
|
||||||
|
- Each branch must be scoped to a single user story
|
||||||
|
- Follow branching strategy requirements set forth in Section 3
|
||||||
|
|
||||||
|
**Commit Practices:**
|
||||||
|
- Commit early and commit often
|
||||||
|
- Push code to remote repository regularly
|
||||||
|
- Regular commits and pushes prevent loss of work
|
||||||
|
- Maintain clear commit messages following project standards
|
||||||
|
|
||||||
|
## 7. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 7.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 7.2. Code Development Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes code development procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify development procedures at any time
|
||||||
|
- Code reviews do not guarantee acceptance of contributions
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete development work
|
||||||
|
- Individual results may vary based on participant skill, effort, and other factors
|
||||||
|
|
||||||
|
### 7.3. Intellectual Property Considerations
|
||||||
|
|
||||||
|
All code developed as part of the Mentorship Programme is subject to our Mentorship Programme Terms and Conditions regarding intellectual property rights. Participants should familiarise themselves with these terms before beginning development work.
|
||||||
|
|
||||||
|
## 8. CONCLUSION
|
||||||
|
|
||||||
|
This Writing Code Documentation establishes the procedures and requirements for code development within our Mentorship Programme. All participants must comply with these procedures to ensure code quality, maintainability, and alignment with professional development standards.
|
||||||
|
|
||||||
|
Questions about code development procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about code development procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,33 +2,164 @@
|
|||||||
title: 08. Final Polish
|
title: 08. Final Polish
|
||||||
---
|
---
|
||||||
|
|
||||||
When you feel like your flagship project has reached a state where you can proudly show it off on your resume, ping Naomi yet again in the #mentee-chat.
|
**ESTABLISHING FINAL POLISH AND DEPLOYMENT PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
## Code Cleanup
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
At this point, we will go through your project with a fine-toothed comb, adding new issues as we identify things that need to be resolved.
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
You'll need to circle back and address those issues - and we will rinse and repeat this cycle until your project is polished up and ready to go.
|
This Final Polish Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for final project polish, documentation, and deployment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
## Documentation
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
Then, we'll coach you on how to write documentation for your product. You will need to establish the standard documentation files:
|
This Documentation applies to all participants in our Mentorship Programme whose flagship projects have reached a state suitable for resume presentation. All participants must complete the final polish procedures set forth in this Documentation before project completion.
|
||||||
|
|
||||||
- A [README.md](http://readme.md/), which provides a high-level overview of your project
|
**IMPORTANT: Final polish procedures are mandatory for programme completion. Failure to complete these procedures may delay programme graduation or project completion.**
|
||||||
- [CONTRIBUTING.md](http://contributing.md/), which has the instructions for someone looking to come help work on your project
|
|
||||||
- [LICENSE.md](http://license.md/), which determines what people can and cannot do with your software
|
|
||||||
|
|
||||||
We will also determine an approach for in-depth end user documentation.
|
## 2. FINAL POLISH INITIATION
|
||||||
|
|
||||||
## Hosting!
|
### 2.1. Readiness Assessment
|
||||||
|
|
||||||
Finally, you need a live version of your application! Our team will help you figure out the best way to deploy your app, and which hosting providers will fit your needs.
|
When participants believe their flagship project has reached a state where it can be proudly shown on a resume, they must:
|
||||||
|
|
||||||
:::caution
|
- Contact programme leadership through the #mentee-chat channel in our Discord community
|
||||||
You definitely want to consult with us BEFORE deploying your application, as we can provide guidance such as free hosting options, deployment pipelines, etc.
|
- Request initiation of final polish procedures
|
||||||
:::
|
- Provide access to the project repository for review
|
||||||
|
|
||||||
We will also help you set up a domain to point to your live project, if you are interested - note that domains generally cost money. So does hosting. We'll do our best to find free options for you, but that's not always viable.
|
### 2.2. Programme Leadership Review
|
||||||
|
|
||||||
|
Programme leadership will assess project readiness and initiate final polish procedures when appropriate.
|
||||||
|
|
||||||
|
## 3. CODE CLEANUP PROCESS
|
||||||
|
|
||||||
|
### 3.1. Comprehensive Code Review
|
||||||
|
|
||||||
|
**Review Process:**
|
||||||
|
- Programme leadership will conduct a comprehensive review of the project
|
||||||
|
- Review will identify issues requiring resolution
|
||||||
|
- New issues will be created in the project repository for each identified concern
|
||||||
|
|
||||||
|
### 3.2. Issue Resolution Cycle
|
||||||
|
|
||||||
|
**Iterative Process:**
|
||||||
|
- Participants must address all identified issues
|
||||||
|
- Programme leadership will review resolved issues
|
||||||
|
- Additional issues may be identified during review
|
||||||
|
- This cycle continues until the project meets polish standards
|
||||||
|
|
||||||
|
**Completion Criteria:**
|
||||||
|
- All identified issues must be resolved
|
||||||
|
- Project must meet quality and polish standards
|
||||||
|
- Code must be ready for professional presentation
|
||||||
|
|
||||||
|
## 4. DOCUMENTATION REQUIREMENTS
|
||||||
|
|
||||||
|
### 4.1. Documentation Coaching
|
||||||
|
|
||||||
|
Programme leadership will provide coaching on writing documentation for the flagship project.
|
||||||
|
|
||||||
|
### 4.2. Required Documentation Files
|
||||||
|
|
||||||
|
**Mandatory Documentation:**
|
||||||
|
Participants must create the following standard documentation files:
|
||||||
|
|
||||||
|
**4.2.1 README.md:**
|
||||||
|
- Provides a high-level overview of the project
|
||||||
|
- Includes project description, features, and usage instructions
|
||||||
|
- Contains installation and setup instructions
|
||||||
|
- Includes contribution guidelines and project information
|
||||||
|
|
||||||
|
**4.2.2 CONTRIBUTING.md:**
|
||||||
|
- Contains instructions for individuals seeking to contribute to the project
|
||||||
|
- Outlines contribution guidelines and procedures
|
||||||
|
- Describes development workflow and standards
|
||||||
|
- Provides information about code review and submission processes
|
||||||
|
|
||||||
|
**4.2.3 LICENSE.md:**
|
||||||
|
- Determines what people can and cannot do with the software
|
||||||
|
- Specifies licensing terms and conditions
|
||||||
|
- Must comply with applicable intellectual property requirements
|
||||||
|
- Should align with project goals and organisational policies
|
||||||
|
|
||||||
|
### 4.3. End User Documentation
|
||||||
|
|
||||||
|
**Documentation Approach:**
|
||||||
|
- Programme leadership will help determine an approach for in-depth end user documentation
|
||||||
|
- Documentation approach will be tailored to project type and complexity
|
||||||
|
- End user documentation should be comprehensive and accessible
|
||||||
|
|
||||||
|
## 5. DEPLOYMENT AND HOSTING
|
||||||
|
|
||||||
|
### 5.1. Deployment Requirement
|
||||||
|
|
||||||
|
**Mandatory Requirement:**
|
||||||
|
Participants must deploy a live version of their application.
|
||||||
|
|
||||||
|
### 5.2. Deployment Consultation
|
||||||
|
|
||||||
|
**IMPORTANT: Participants MUST consult with programme leadership BEFORE deploying their application.**
|
||||||
|
|
||||||
|
**Consultation Benefits:**
|
||||||
|
- Programme leadership can provide guidance on deployment options
|
||||||
|
- Information about free hosting options may be available
|
||||||
|
- Assistance with deployment pipeline configuration
|
||||||
|
- Recommendations for hosting providers that fit project needs
|
||||||
|
|
||||||
|
### 5.3. Hosting Provider Selection
|
||||||
|
|
||||||
|
**Selection Process:**
|
||||||
|
- Programme leadership will help identify appropriate hosting providers
|
||||||
|
- Considerations include project requirements, budget, and scalability needs
|
||||||
|
- Free hosting options will be explored when available
|
||||||
|
- Paid hosting options may be necessary depending on project requirements
|
||||||
|
|
||||||
|
### 5.4. Domain Configuration
|
||||||
|
|
||||||
|
**Domain Setup:**
|
||||||
|
- Programme leadership can assist with domain configuration
|
||||||
|
- Domains generally require payment
|
||||||
|
- Free domain options may be available in some cases
|
||||||
|
- Domain setup is optional but recommended for professional presentation
|
||||||
|
|
||||||
|
**Cost Considerations:**
|
||||||
|
- Domains generally cost money
|
||||||
|
- Hosting generally costs money
|
||||||
|
- Programme leadership will seek free options when possible
|
||||||
|
- Free options may not always be viable depending on project requirements
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Final Polish Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes final polish procedures and requirements. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify final polish procedures at any time
|
||||||
|
- Final polish does not guarantee specific project outcomes or employment results
|
||||||
|
- Programme leadership is not responsible for participants' ability to complete final polish procedures
|
||||||
|
- Individual results may vary based on participant effort, project complexity, and other factors
|
||||||
|
|
||||||
|
### 6.3. Hosting and Deployment Disclaimer
|
||||||
|
|
||||||
|
Programme leadership provides guidance on hosting and deployment but:
|
||||||
|
|
||||||
|
- Does not guarantee availability of free hosting options
|
||||||
|
- Is not responsible for hosting provider service quality or availability
|
||||||
|
- Does not assume responsibility for deployment issues or service disruptions
|
||||||
|
- Recommends that participants review hosting provider terms of service and policies
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Final Polish Documentation establishes the procedures and requirements for final project polish, documentation, and deployment within our Mentorship Programme. All participants must complete these procedures to achieve programme completion standards.
|
||||||
|
|
||||||
|
Questions about final polish procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about final polish procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,27 +2,150 @@
|
|||||||
title: 09. Career Prep
|
title: 09. Career Prep
|
||||||
---
|
---
|
||||||
|
|
||||||
Hurray! You made it! It is now time to start your job hunt in earnest! There are a few things we will do to help you get ready for this process.
|
**ESTABLISHING CAREER PREPARATION PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
## Resume Review
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
We will work with you to get a polished resume/CV ready to hand out to potential employers. And your resume will definitely include your flagship project!
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
## LinkedIn Prep
|
This Career Preparation Documentation (hereinafter referred to as "the Documentation") establishes procedures and requirements for career preparation activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
We will help you curate your LinkedIn profile to help you stand out and position you for success.
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
## Application Assistance
|
This Documentation applies to all participants in our Mentorship Programme who are ready to begin their job search. Programme leadership will provide support and assistance with career preparation activities as set forth in this Documentation.
|
||||||
|
|
||||||
We will gladly help you refine your job search and application process. We cannot, and will not, complete job applications for you - but will totally help you figure out what to say.
|
**IMPORTANT: Career preparation support is provided to assist participants in their job search. Programme leadership does not guarantee employment outcomes or specific job placement results.**
|
||||||
|
|
||||||
## Mock Interviews
|
## 2. CAREER PREPARATION SUPPORT
|
||||||
|
|
||||||
Once you start landing interviews, we will do some mock interviews to best prepare you to succeed in the real thing!
|
### 2.1. Support Availability
|
||||||
|
|
||||||
## JOB!!!!!
|
Upon reaching the career preparation stage, programme leadership will provide assistance with various aspects of the job search process as outlined in Sections 3 through 6 of this Documentation.
|
||||||
|
|
||||||
We will continue to do all of this, and refine and iterate on your flagship project, until we have reached the magical combo that gets you employed! 🎉
|
### 2.2. Support Scope
|
||||||
|
|
||||||
|
Programme leadership will continue to provide career preparation support and refine flagship projects until participants achieve employment, subject to programme terms and conditions.
|
||||||
|
|
||||||
|
## 3. RESUME REVIEW
|
||||||
|
|
||||||
|
### 3.1. Resume Development Support
|
||||||
|
|
||||||
|
**Support Provided:**
|
||||||
|
- Programme leadership will work with participants to develop polished resumes/CVs
|
||||||
|
- Resumes will be prepared for distribution to potential employers
|
||||||
|
- Resume content will be reviewed and refined for effectiveness
|
||||||
|
|
||||||
|
### 3.2. Flagship Project Inclusion
|
||||||
|
|
||||||
|
**Mandatory Requirement:**
|
||||||
|
- Resumes must include the flagship project developed during the Mentorship Programme
|
||||||
|
- Flagship project serves as a demonstration of skills and capabilities
|
||||||
|
- Project presentation on resume will be reviewed and refined
|
||||||
|
|
||||||
|
## 4. LINKEDIN PROFILE PREPARATION
|
||||||
|
|
||||||
|
### 4.1. LinkedIn Profile Support
|
||||||
|
|
||||||
|
**Support Provided:**
|
||||||
|
- Programme leadership will assist in curating LinkedIn profiles
|
||||||
|
- Profile optimisation to help participants stand out
|
||||||
|
- Strategic positioning for career success
|
||||||
|
- Content review and refinement
|
||||||
|
|
||||||
|
### 4.2. Profile Optimization
|
||||||
|
|
||||||
|
LinkedIn profile preparation focuses on:
|
||||||
|
- Professional presentation and branding
|
||||||
|
- Highlighting relevant skills and experience
|
||||||
|
- Showcasing flagship project and achievements
|
||||||
|
- Optimizing profile for recruiter visibility
|
||||||
|
|
||||||
|
## 5. APPLICATION ASSISTANCE
|
||||||
|
|
||||||
|
### 5.1. Job Search Support
|
||||||
|
|
||||||
|
**Support Provided:**
|
||||||
|
- Programme leadership will help refine job search strategies
|
||||||
|
- Assistance with identifying appropriate job opportunities
|
||||||
|
- Guidance on application processes and requirements
|
||||||
|
|
||||||
|
### 5.2. Application Content Assistance
|
||||||
|
|
||||||
|
**Support Scope:**
|
||||||
|
- Programme leadership will help participants determine what to say in applications
|
||||||
|
- Assistance with crafting effective application materials
|
||||||
|
- Review and feedback on application content
|
||||||
|
|
||||||
|
**Limitations:**
|
||||||
|
- Programme leadership cannot and will not complete job applications on behalf of participants
|
||||||
|
- Participants are responsible for submitting their own applications
|
||||||
|
- Support is limited to guidance and feedback on application content
|
||||||
|
|
||||||
|
## 6. MOCK INTERVIEWS
|
||||||
|
|
||||||
|
### 6.1. Interview Preparation
|
||||||
|
|
||||||
|
**Support Provided:**
|
||||||
|
- Programme leadership will conduct mock interviews with participants
|
||||||
|
- Mock interviews prepare participants for real interview situations
|
||||||
|
- Feedback and coaching on interview performance
|
||||||
|
- Practice with common interview questions and scenarios
|
||||||
|
|
||||||
|
### 6.2. Interview Timing
|
||||||
|
|
||||||
|
**Initiation:**
|
||||||
|
- Mock interviews begin once participants start landing actual interviews
|
||||||
|
- Preparation focuses on real interview scenarios participants will face
|
||||||
|
- Ongoing support as participants progress through interview processes
|
||||||
|
|
||||||
|
## 7. CONTINUOUS SUPPORT
|
||||||
|
|
||||||
|
### 7.1. Ongoing Assistance
|
||||||
|
|
||||||
|
**Support Continuity:**
|
||||||
|
- Programme leadership will continue providing all career preparation support
|
||||||
|
- Flagship project refinement and iteration will continue
|
||||||
|
- Support continues until participants achieve employment
|
||||||
|
|
||||||
|
### 7.2. Goal Achievement
|
||||||
|
|
||||||
|
**Programme Focus:**
|
||||||
|
- Programme leadership works with participants until they achieve employment
|
||||||
|
- Combination of career preparation activities and project refinement
|
||||||
|
- Goal is to help participants reach their career objectives
|
||||||
|
|
||||||
|
## 8. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 8.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 8.2. Career Preparation Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes career preparation procedures and support. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify career preparation procedures at any time
|
||||||
|
- Career preparation support does not guarantee employment outcomes
|
||||||
|
- Programme leadership is not responsible for participants' ability to secure employment
|
||||||
|
- Individual results may vary based on participant effort, market conditions, and other factors
|
||||||
|
|
||||||
|
### 8.3. Employment Outcome Disclaimer
|
||||||
|
|
||||||
|
**IMPORTANT: Programme leadership provides career preparation support but does not guarantee:**
|
||||||
|
- Specific employment outcomes or job placement
|
||||||
|
- Interview invitations or job offers
|
||||||
|
- Salary levels or compensation packages
|
||||||
|
- Employment within any specific timeframe
|
||||||
|
|
||||||
|
## 9. CONCLUSION
|
||||||
|
|
||||||
|
This Career Preparation Documentation establishes the procedures and support available for career preparation within our Mentorship Programme. Programme leadership will provide comprehensive support to help participants prepare for and succeed in their job search.
|
||||||
|
|
||||||
|
Questions about career preparation procedures should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about career preparation procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,19 +2,139 @@
|
|||||||
title: 10. Graduation
|
title: 10. Graduation
|
||||||
---
|
---
|
||||||
|
|
||||||
Our mentorship programme is very flexible. There are no set deadlines, no requirements you must complete to "finish the programme", etc.
|
**ESTABLISHING GRADUATION CRITERIA AND ALUMNI PROGRAMME PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
|
||||||
|
|
||||||
Instead, we focus on one thing and one thing only: reaching your career goals. As such, once you land your dev job, you have completed the mentorship programme!
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
:::tip
|
### 1.1. Policy Overview
|
||||||
It is entirely possible that you land a job before you even complete your flagship project. That repository is yours to keep forever, so you will be able to continue working on it as you like. But when you land your job, regardless of where you are at in your roadmap, you will have successfully graduated from our programme!
|
|
||||||
:::
|
|
||||||
|
|
||||||
While we will gladly provide continued coaching, advice, and recommendations, we *will* remove you from the official programme once you are hired. This allows us to open up space for the next generation of developers looking to find their success just like you did!
|
This Graduation Documentation (hereinafter referred to as "the Documentation") establishes graduation criteria, procedures, and alumni programme information for our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
|
||||||
|
|
||||||
We do maintain an alumni programme. You will still have access to post in the mentorship channels, but not to get help with your own plan - instead, you'll be helping coach and guide others! Succeeding as a developer requires leadership skills, and our hope with the alumni programme is to give you the space to develop those skills.
|
### 1.2. Scope and Applicability
|
||||||
|
|
||||||
You will also go on our public list of alumni!
|
This Documentation applies to all participants in our Mentorship Programme. Graduation criteria and procedures set forth in this Documentation determine programme completion and transition to alumni status.
|
||||||
|
|
||||||
|
**IMPORTANT: Programme completion is determined by achievement of career goals, not completion of specific programme milestones or deadlines.**
|
||||||
|
|
||||||
|
## 2. PROGRAMME FLEXIBILITY
|
||||||
|
|
||||||
|
### 2.1. Flexible Programme Structure
|
||||||
|
|
||||||
|
**Programme Characteristics:**
|
||||||
|
- Our Mentorship Programme is designed to be highly flexible
|
||||||
|
- No set deadlines are imposed on participants
|
||||||
|
- No specific requirements must be completed to "finish the programme"
|
||||||
|
- Programme structure adapts to individual participant needs and circumstances
|
||||||
|
|
||||||
|
### 2.2. Goal-Oriented Approach
|
||||||
|
|
||||||
|
**Primary Focus:**
|
||||||
|
- Programme focuses exclusively on helping participants reach their career goals
|
||||||
|
- Success is measured by achievement of career objectives, not programme milestones
|
||||||
|
- Programme structure supports individual learning paths and timelines
|
||||||
|
|
||||||
|
## 3. GRADUATION CRITERIA
|
||||||
|
|
||||||
|
### 3.1. Graduation Requirement
|
||||||
|
|
||||||
|
**Completion Standard:**
|
||||||
|
Once a participant lands a development job, they have completed the Mentorship Programme and are considered graduated.
|
||||||
|
|
||||||
|
### 3.2. Early Graduation
|
||||||
|
|
||||||
|
**Flexible Completion:**
|
||||||
|
- Participants may land a job before completing their flagship project
|
||||||
|
- Early employment does not prevent programme completion
|
||||||
|
- Graduation occurs upon job acceptance, regardless of project completion status
|
||||||
|
|
||||||
|
### 3.3. Repository Retention
|
||||||
|
|
||||||
|
**Repository Ownership:**
|
||||||
|
- Flagship project repository remains available to participants forever
|
||||||
|
- Participants may continue working on their project after graduation
|
||||||
|
- Repository access is not affected by programme completion
|
||||||
|
|
||||||
|
### 3.4. Roadmap Completion Status
|
||||||
|
|
||||||
|
**Completion Flexibility:**
|
||||||
|
- Graduation is not dependent on roadmap completion
|
||||||
|
- Participants may graduate at any point in their roadmap upon job acceptance
|
||||||
|
- Programme completion is determined solely by employment achievement
|
||||||
|
|
||||||
|
## 4. POST-GRADUATION TRANSITION
|
||||||
|
|
||||||
|
### 4.1. Programme Removal
|
||||||
|
|
||||||
|
**Official Programme Status:**
|
||||||
|
- Participants will be removed from the official programme upon hiring
|
||||||
|
- Removal allows space for new participants seeking programme access
|
||||||
|
- Transition supports programme capacity management and accessibility
|
||||||
|
|
||||||
|
### 4.2. Continued Support
|
||||||
|
|
||||||
|
**Ongoing Assistance:**
|
||||||
|
- Programme leadership will continue to provide coaching, advice, and recommendations
|
||||||
|
- Support continues after graduation on an informal basis
|
||||||
|
- Formal programme structure ends upon graduation
|
||||||
|
|
||||||
|
## 5. ALUMNI PROGRAMME
|
||||||
|
|
||||||
|
### 5.1. Alumni Programme Overview
|
||||||
|
|
||||||
|
**Programme Availability:**
|
||||||
|
- Our organisation maintains an alumni programme for graduated participants
|
||||||
|
- Alumni programme provides continued community engagement opportunities
|
||||||
|
- Alumni contribute to programme success through mentorship and guidance
|
||||||
|
|
||||||
|
### 5.2. Alumni Access and Responsibilities
|
||||||
|
|
||||||
|
**Channel Access:**
|
||||||
|
- Alumni retain access to post in mentorship channels
|
||||||
|
- Access is provided for coaching and guiding current participants
|
||||||
|
- Alumni do not receive help with their own development plans
|
||||||
|
|
||||||
|
**Leadership Development:**
|
||||||
|
- Alumni programme focuses on developing leadership skills
|
||||||
|
- Alumni contribute by coaching and guiding new participants
|
||||||
|
- Leadership development supports professional growth and community contribution
|
||||||
|
|
||||||
|
### 5.3. Public Recognition
|
||||||
|
|
||||||
|
**Alumni Listing:**
|
||||||
|
- Graduated participants are added to our public list of alumni
|
||||||
|
- Public recognition celebrates participant achievements
|
||||||
|
- Alumni listing demonstrates programme success and participant outcomes
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Graduation Disclaimer
|
||||||
|
|
||||||
|
This Documentation establishes graduation criteria and procedures. However:
|
||||||
|
|
||||||
|
- Programme leadership reserves the right to modify graduation procedures at any time
|
||||||
|
- Programme completion does not guarantee specific employment outcomes or career success
|
||||||
|
- Individual results may vary based on participant effort, market conditions, and other factors
|
||||||
|
|
||||||
|
### 6.3. Alumni Programme Disclaimer
|
||||||
|
|
||||||
|
**Alumni Programme Terms:**
|
||||||
|
- Alumni programme participation is subject to programme terms and conditions
|
||||||
|
- Alumni access and privileges may be modified or revoked at any time
|
||||||
|
- Alumni programme does not guarantee continued access or specific benefits
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Graduation Documentation establishes the criteria and procedures for programme completion and transition to alumni status. Our Mentorship Programme is designed to be flexible and goal-oriented, with graduation determined by achievement of career objectives rather than completion of specific programme milestones.
|
||||||
|
|
||||||
|
Questions about graduation procedures or alumni programme participation should be directed to programme leadership through designated communication channels. For comprehensive programme terms and conditions, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about graduation procedures or programme participation, please contact programme leadership through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|
||||||
:::tip[Helpful Links]
|
:::tip[Helpful Links]
|
||||||
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
- [Apply to join](https://forms.nhcarrigan.com/form/gNv4NYZmdiMWpkUcnknII2yYCvnYNGAmabG5O5He9Mo)
|
||||||
|
|||||||
@@ -2,9 +2,32 @@
|
|||||||
title: Managing Local Music
|
title: Managing Local Music
|
||||||
---
|
---
|
||||||
|
|
||||||
This serves as our documentation for how we manage our local music libraries on Linux.
|
**DOCUMENTING LOCAL MUSIC LIBRARY MANAGEMENT PROCEDURES**
|
||||||
|
|
||||||
## Acquiring Music
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Music Management Documentation (hereinafter referred to as "the Documentation") provides technical procedures and instructions for managing local music libraries on Linux systems. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
|
This Documentation describes technical procedures for managing local music libraries. This information is provided for informational purposes and personal use only.
|
||||||
|
|
||||||
|
**IMPORTANT: Users are solely responsible for ensuring that all music acquisition, storage, and management activities comply with applicable copyright laws, licensing agreements, and legal requirements. Our organisation does not condone or support any illegal activities, including copyright infringement or piracy.**
|
||||||
|
|
||||||
|
### 1.3. Legal Compliance Disclaimer
|
||||||
|
|
||||||
|
All users must ensure that their music acquisition and management activities comply with:
|
||||||
|
|
||||||
|
- Applicable copyright laws and regulations
|
||||||
|
- Terms of service of music platforms and services
|
||||||
|
- Licensing agreements for music content
|
||||||
|
- All relevant intellectual property laws
|
||||||
|
|
||||||
|
Our organisation assumes no responsibility for any illegal activities conducted using information from this Documentation.
|
||||||
|
|
||||||
|
## 2. ACQUIRING MUSIC
|
||||||
|
|
||||||
You are welcome to use any method you wish to *LEGALLY* acquire music. We would never encourage the criminal act of piracy. But maybe you're an artist and you want to archive or back up your own music - in that case, here you go:
|
You are welcome to use any method you wish to *LEGALLY* acquire music. We would never encourage the criminal act of piracy. But maybe you're an artist and you want to archive or back up your own music - in that case, here you go:
|
||||||
|
|
||||||
@@ -14,7 +37,7 @@ yt-dlp -x --audio-format mp3 <url> --cookies-from-browser firefox
|
|||||||
|
|
||||||
Omit the `--cookies-from-browser firefox` if you do not need authentication (auth is required for age-restricted content, for example).
|
Omit the `--cookies-from-browser firefox` if you do not need authentication (auth is required for age-restricted content, for example).
|
||||||
|
|
||||||
## Editing Metadata
|
## 3. EDITING METADATA
|
||||||
|
|
||||||
The specific meta tags you may need to set will vary depending on the music software you use. We have confirmed that `TIT2` is read as the title and `TPE1` is read as the artist when using Amberol on Linux and Musicolet on Android. Using `-t` and `-a` might work.
|
The specific meta tags you may need to set will vary depending on the music software you use. We have confirmed that `TIT2` is read as the title and `TPE1` is read as the artist when using Amberol on Linux and Musicolet on Android. Using `-t` and `-a` might work.
|
||||||
|
|
||||||
@@ -22,7 +45,7 @@ The specific meta tags you may need to set will vary depending on the music soft
|
|||||||
id3v2 "/path/to/song" --TIT2 "Song Title" --TPE1 "Song Artist"
|
id3v2 "/path/to/song" --TIT2 "Song Title" --TPE1 "Song Artist"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Adding Cover Image
|
## 4. ADDING COVER IMAGES
|
||||||
|
|
||||||
Download the image (we have confirmed JPEGs work) that you want to apply to the song, then run:
|
Download the image (we have confirmed JPEGs work) that you want to apply to the song, then run:
|
||||||
|
|
||||||
@@ -30,10 +53,42 @@ Download the image (we have confirmed JPEGs work) that you want to apply to the
|
|||||||
eyeD3 --add-image="/path/to/img":FRONT_COVER "/path/to/mp3"
|
eyeD3 --add-image="/path/to/img":FRONT_COVER "/path/to/mp3"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Copying to Android Locally
|
## 5. COPYING TO ANDROID DEVICES
|
||||||
|
|
||||||
You'll need to replace your paths and your device ID to match your local setup, but:
|
You'll need to replace your paths and your device ID to match your local setup, but:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
adb -s 192.168.12.105:5555 push music/* /storage/self/primary/Music
|
adb -s 192.168.12.105:5555 push music/* /storage/self/primary/Music
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 6.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 6.2. Legal Compliance Disclaimer
|
||||||
|
|
||||||
|
This Documentation provides technical procedures only. Our organisation:
|
||||||
|
|
||||||
|
- Does not provide legal advice regarding music acquisition or copyright compliance
|
||||||
|
- Does not endorse or support any illegal activities, including copyright infringement
|
||||||
|
- Assumes no responsibility for users' compliance with copyright laws or licensing agreements
|
||||||
|
- Recommends that users consult qualified legal counsel for questions about copyright compliance
|
||||||
|
|
||||||
|
### 6.3. Technical Accuracy Disclaimer
|
||||||
|
|
||||||
|
While we strive to maintain accurate and current information in this Documentation, software tools, commands, and procedures may change over time. Users are responsible for:
|
||||||
|
|
||||||
|
- Verifying current software versions and compatibility
|
||||||
|
- Adapting procedures to their specific system configurations
|
||||||
|
- Ensuring their technical setup meets the requirements for these procedures
|
||||||
|
- Consulting additional resources for the most current technical information
|
||||||
|
|
||||||
|
## 7. CONCLUSION
|
||||||
|
|
||||||
|
This Music Management Documentation provides technical procedures for managing local music libraries on Linux systems. All users must ensure that their use of these procedures complies with applicable copyright laws, licensing agreements, and legal requirements.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about music management procedures or legal compliance, please consult qualified legal counsel.*
|
||||||
|
|||||||
@@ -2,9 +2,32 @@
|
|||||||
title: AI Prompts
|
title: AI Prompts
|
||||||
---
|
---
|
||||||
|
|
||||||
Here are various prompts we use throughout our workflows.
|
**DOCUMENTING STANDARD AI PROMPTS AND WORKFLOW TEMPLATES**
|
||||||
|
|
||||||
## Documentation Generation Prompt
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This AI Prompts Documentation (hereinafter referred to as "the Documentation") provides standard prompts, templates, and workflow instructions for using artificial intelligence tools in our organisational workflows. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
|
This Documentation serves as a reference for standardised AI prompts used in various organisational contexts. These prompts are provided for convenience and consistency but may require customisation for specific use cases.
|
||||||
|
|
||||||
|
**IMPORTANT: These prompts are provided as starting points and may require modification to meet specific requirements. Users are responsible for ensuring that any use of AI tools complies with applicable laws, regulations, and organisational policies.**
|
||||||
|
|
||||||
|
### 1.3. AI Tool Usage Disclaimer
|
||||||
|
|
||||||
|
Our organisation does not guarantee the accuracy, reliability, or appropriateness of outputs generated using these prompts. Users are responsible for:
|
||||||
|
|
||||||
|
- Reviewing and validating all AI-generated content
|
||||||
|
- Ensuring compliance with applicable laws and regulations
|
||||||
|
- Maintaining appropriate oversight of AI tool usage
|
||||||
|
- Protecting sensitive or confidential information when using AI tools
|
||||||
|
|
||||||
|
## 2. AI PROMPTS
|
||||||
|
|
||||||
|
### 2.1. Documentation Generation Prompt
|
||||||
|
|
||||||
Open Claude Code in your project directory, then provide this prompt:
|
Open Claude Code in your project directory, then provide this prompt:
|
||||||
|
|
||||||
@@ -34,7 +57,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
```
|
```
|
||||||
|
|
||||||
## Comprehension Question Generation Prompt
|
### 2.2. Comprehension Question Generation Prompt
|
||||||
|
|
||||||
We use this for some of our client work, but this is great for creating questions to quiz yourself on any document you've read.
|
We use this for some of our client work, but this is great for creating questions to quiz yourself on any document you've read.
|
||||||
|
|
||||||
@@ -56,7 +79,7 @@ Which of the following is a key characteristic of relational databases?
|
|||||||
|
|
||||||
**D.** Structured data in tables
|
**D.** Structured data in tables
|
||||||
|
|
||||||
Hint: Think about how data is organized in relational databases.
|
Hint: Think about how data is organised in relational databases.
|
||||||
|
|
||||||
Answer: **D.** Structured data in tables
|
Answer: **D.** Structured data in tables
|
||||||
|
|
||||||
@@ -72,7 +95,7 @@ Which of the following is a key characteristic of relational databases?
|
|||||||
|
|
||||||
**D.** Structured data in tables
|
**D.** Structured data in tables
|
||||||
|
|
||||||
Hint: Think about how data is organized in relational databases.
|
Hint: Think about how data is organised in relational databases.
|
||||||
|
|
||||||
Answer: **D.** Structured data in tables
|
Answer: **D.** Structured data in tables
|
||||||
|
|
||||||
@@ -88,8 +111,41 @@ Which of the following is a key characteristic of relational databases?
|
|||||||
|
|
||||||
**D.** Structured data in tables
|
**D.** Structured data in tables
|
||||||
|
|
||||||
Hint: Think about how data is organized in relational databases.
|
Hint: Think about how data is organised in relational databases.
|
||||||
|
|
||||||
Answer: **D.** Structured data in tables
|
Answer: **D.** Structured data in tables
|
||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
|
## 3. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 3.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 3.2. AI Tool Usage Disclaimer
|
||||||
|
|
||||||
|
These prompts are provided for informational purposes only. Our organisation:
|
||||||
|
|
||||||
|
- Does not guarantee the accuracy, reliability, or appropriateness of outputs generated using these prompts
|
||||||
|
- Does not warrant that these prompts will produce desired results in all contexts
|
||||||
|
- Assumes no responsibility for outcomes resulting from the use of these prompts with AI tools
|
||||||
|
- Recommends that users review and validate all AI-generated content
|
||||||
|
|
||||||
|
### 3.3. User Responsibilities
|
||||||
|
|
||||||
|
Users are responsible for:
|
||||||
|
|
||||||
|
- Reviewing and validating all AI-generated content before use
|
||||||
|
- Ensuring compliance with applicable laws, regulations, and organisational policies
|
||||||
|
- Protecting sensitive or confidential information when using AI tools
|
||||||
|
- Maintaining appropriate oversight and quality control of AI tool usage
|
||||||
|
- Adapting prompts to meet specific requirements and contexts
|
||||||
|
|
||||||
|
## 4. CONCLUSION
|
||||||
|
|
||||||
|
This AI Prompts Documentation provides standardised prompts and workflow templates for using artificial intelligence tools in our organisational workflows. All users are responsible for ensuring that their use of these prompts complies with applicable laws, regulations, and organisational policies, and for maintaining appropriate oversight of AI tool usage.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about AI prompt usage or to suggest improvements, please contact appropriate organisational leadership through designated communication channels.*
|
||||||
@@ -2,9 +2,27 @@
|
|||||||
title: Templates
|
title: Templates
|
||||||
---
|
---
|
||||||
|
|
||||||
This page documents various templates we have found useful.
|
**PROVIDING STANDARD TEMPLATES AND DOCUMENTATION FORMS**
|
||||||
|
|
||||||
## DMCA Takedown
|
## 1. INTRODUCTION AND LEGAL FRAMEWORK
|
||||||
|
|
||||||
|
### 1.1. Policy Overview
|
||||||
|
|
||||||
|
This Templates Documentation (hereinafter referred to as "the Documentation") provides standard templates, forms, and documentation formats used throughout our organisation. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
|
||||||
|
|
||||||
|
### 1.2. Purpose and Scope
|
||||||
|
|
||||||
|
This Documentation serves as a reference for standardised templates used in various organisational contexts. These templates are provided for convenience and consistency but may require customisation for specific use cases.
|
||||||
|
|
||||||
|
**IMPORTANT: These templates are provided as starting points and may require modification to meet specific legal, regulatory, or contextual requirements. Users are responsible for ensuring that any use of these templates complies with applicable laws and regulations.**
|
||||||
|
|
||||||
|
### 1.3. Disclaimer
|
||||||
|
|
||||||
|
Our organisation does not provide legal advice. These templates are provided for informational purposes only. Users should consult with qualified legal counsel when using these templates for legal matters or when compliance with specific regulations is required.
|
||||||
|
|
||||||
|
## 2. TEMPLATES
|
||||||
|
|
||||||
|
### 2.1. DMCA Takedown Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
To whom it may concern:
|
To whom it may concern:
|
||||||
@@ -32,7 +50,7 @@ We swear, under penalty of perjury, that the information in this notification is
|
|||||||
If you have any questions, please feel free to reach out to us.
|
If you have any questions, please feel free to reach out to us.
|
||||||
```
|
```
|
||||||
|
|
||||||
## LinkedIn Cold Outreach Response
|
### 2.2. LinkedIn Cold Outreach Response Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
I would be more than happy to chat! Please fill out my meeting form so we can start the scheduling process!
|
I would be more than happy to chat! Please fill out my meeting form so we can start the scheduling process!
|
||||||
@@ -40,7 +58,7 @@ I would be more than happy to chat! Please fill out my meeting form so we can st
|
|||||||
https://forms.nhcarrigan.com/form/uUKZiJSDm6847iDOlpZkD5QF7cAjoTbTm0F4T0EdW0I
|
https://forms.nhcarrigan.com/form/uUKZiJSDm6847iDOlpZkD5QF7cAjoTbTm0F4T0EdW0I
|
||||||
```
|
```
|
||||||
|
|
||||||
## LinkedIn Post-Event Recommendation
|
### 2.3. LinkedIn Post-Event Recommendation Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
I had the absolute pleasure of working with [Participant's Name] during our [event name], where [they] consistently impressed me with [their] dedication, technical growth, and collaborative spirit.
|
I had the absolute pleasure of working with [Participant's Name] during our [event name], where [they] consistently impressed me with [their] dedication, technical growth, and collaborative spirit.
|
||||||
@@ -54,7 +72,7 @@ By the end of the [event name], [Participant's Name] had delivered an outstandin
|
|||||||
I wholeheartedly recommend [Participant's Name] for any opportunity in tech. [They] bring not just technical ability, but the kind of energy and curiosity that makes any team stronger.
|
I wholeheartedly recommend [Participant's Name] for any opportunity in tech. [They] bring not just technical ability, but the kind of energy and curiosity that makes any team stronger.
|
||||||
```
|
```
|
||||||
|
|
||||||
## LinkedIn Mentorship Recommendation
|
### 2.4. LinkedIn Mentorship Recommendation Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
I had the privilege of mentoring [Mentee's Name] through my 1:1 mentorship programme, and from our very first session, it was clear that [they] approached learning with curiosity, determination, and an eagerness to grow.
|
I had the privilege of mentoring [Mentee's Name] through my 1:1 mentorship programme, and from our very first session, it was clear that [they] approached learning with curiosity, determination, and an eagerness to grow.
|
||||||
@@ -66,7 +84,7 @@ What impressed me most was [their] commitment to personal and professional growt
|
|||||||
I am confident that [Mentee's Name] will continue to excel in their career. They bring the kind of focus, curiosity, and dedication that make them a valuable asset to any team, and I am proud to have played a part in their journey.
|
I am confident that [Mentee's Name] will continue to excel in their career. They bring the kind of focus, curiosity, and dedication that make them a valuable asset to any team, and I am proud to have played a part in their journey.
|
||||||
```
|
```
|
||||||
|
|
||||||
## Form Submission Declined Email
|
### 2.5. Form Submission Declined Email Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
Hello,
|
Hello,
|
||||||
@@ -86,7 +104,7 @@ We encourage you to take the time to consider these common points of failure, an
|
|||||||
If you have any questions, please reach out in our Discord community: https://chat.nhcarrigan.com
|
If you have any questions, please reach out in our Discord community: https://chat.nhcarrigan.com
|
||||||
```
|
```
|
||||||
|
|
||||||
## Volunteer Application Rejection
|
### 2.6. Volunteer Application Rejection Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
Dear [Applicant’s Name],
|
Dear [Applicant’s Name],
|
||||||
@@ -104,7 +122,7 @@ Naomi Carrigan
|
|||||||
CEO, NHCarrigan
|
CEO, NHCarrigan
|
||||||
```
|
```
|
||||||
|
|
||||||
## Meeting Request Confirmation
|
### 2.7. Meeting Request Confirmation Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
Hey <name>,
|
Hey <name>,
|
||||||
@@ -122,7 +140,7 @@ Please note that if you choose to meet in the NHCarrigan Discord, you will need
|
|||||||
If you have any questions, please do not hesitate to reach out to us.
|
If you have any questions, please do not hesitate to reach out to us.
|
||||||
```
|
```
|
||||||
|
|
||||||
## Mentorship Application Acceptance
|
### 2.8. Mentorship Application Acceptance Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
Hey <name>,
|
Hey <name>,
|
||||||
@@ -138,7 +156,7 @@ Keep an eye on the Discord community for announcements and opportunities to coll
|
|||||||
Congratulations again!
|
Congratulations again!
|
||||||
```
|
```
|
||||||
|
|
||||||
## Discord Bot Donation Copy
|
### 2.9. Discord Bot Donation Copy Template
|
||||||
|
|
||||||
These go in the bot SKUs:
|
These go in the bot SKUs:
|
||||||
|
|
||||||
@@ -160,7 +178,7 @@ Sponsor Naomi
|
|||||||
|
|
||||||
2. Building Inclusive Communities
|
2. Building Inclusive Communities
|
||||||
- Manage welcoming online spaces where diverse voices are celebrated
|
- Manage welcoming online spaces where diverse voices are celebrated
|
||||||
- Organize virtual events, workshops, and mentorship programs
|
- Organise virtual events, workshops, and mentorship programmes
|
||||||
- Implement inclusive community guidelines
|
- Implement inclusive community guidelines
|
||||||
|
|
||||||
3. Guiding Others in Tech
|
3. Guiding Others in Tech
|
||||||
@@ -195,7 +213,7 @@ Helps a transfemme technology witch create free software, build inclusive commun
|
|||||||
- Use my avatar for subscription
|
- Use my avatar for subscription
|
||||||
- Use pentatrans for benefit
|
- Use pentatrans for benefit
|
||||||
|
|
||||||
## Discord Server Intro
|
### 2.10. Discord Server Introduction Template
|
||||||
|
|
||||||
```md
|
```md
|
||||||
Hello~! I'm Naomi, a 34 year old transfem software engineer and community manager based in Washington. All of my work (and therefore most of my life) is spent online, so I'm always looking for new spaces and people to vibe with. Remote work can feel dreadfully isolating, and this is my attempt to combat that feeling.
|
Hello~! I'm Naomi, a 34 year old transfem software engineer and community manager based in Washington. All of my work (and therefore most of my life) is spent online, so I'm always looking for new spaces and people to vibe with. Remote work can feel dreadfully isolating, and this is my attempt to combat that feeling.
|
||||||
@@ -203,7 +221,7 @@ Hello~! I'm Naomi, a 34 year old transfem software engineer and community manage
|
|||||||
<insert bit about community here>
|
<insert bit about community here>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Guild Wars 2 Recruitment Ad
|
### 2.11. Guild Wars 2 Recruitment Advertisement Template
|
||||||
|
|
||||||
This has to be sent in two chat messages because of the length.
|
This has to be sent in two chat messages because of the length.
|
||||||
|
|
||||||
@@ -214,3 +232,35 @@ Hiya friends~! Naomi's Newbies is a new guild that is really focused on helping
|
|||||||
```
|
```
|
||||||
We have no activity requirement, no rep requirement, a Discord community, and more! If you are interested, please whisper me and I will gladly invite you!
|
We have no activity requirement, no rep requirement, a Discord community, and more! If you are interested, please whisper me and I will gladly invite you!
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 3. LIMITATION OF LIABILITY AND DISCLAIMERS
|
||||||
|
|
||||||
|
### 3.1. Reference to Comprehensive Liability Framework
|
||||||
|
|
||||||
|
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
|
||||||
|
|
||||||
|
### 3.2. Template Usage Disclaimer
|
||||||
|
|
||||||
|
These templates are provided for informational purposes only. Our organisation:
|
||||||
|
|
||||||
|
- Does not provide legal advice or guarantee the legal effectiveness of these templates
|
||||||
|
- Does not warrant that these templates will meet specific legal, regulatory, or contextual requirements
|
||||||
|
- Recommends that users consult with qualified legal counsel when using these templates for legal matters
|
||||||
|
- Assumes no responsibility for outcomes resulting from the use of these templates
|
||||||
|
|
||||||
|
### 3.3. Customisation Requirements
|
||||||
|
|
||||||
|
Users are responsible for:
|
||||||
|
|
||||||
|
- Customising templates to meet their specific needs and requirements
|
||||||
|
- Ensuring compliance with applicable laws, regulations, and organisational policies
|
||||||
|
- Verifying the accuracy and appropriateness of template content for their specific use case
|
||||||
|
- Obtaining appropriate legal review when necessary
|
||||||
|
|
||||||
|
## 4. CONCLUSION
|
||||||
|
|
||||||
|
This Templates Documentation provides standardised templates and forms for use throughout our organisation. All users are responsible for ensuring that their use of these templates complies with applicable laws, regulations, and organisational requirements.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For questions about template usage or to suggest improvements, please contact appropriate organisational leadership through designated communication channels.*
|
||||||
@@ -8,11 +8,11 @@ Artists4Palestine Bot (hereinafter the "Application") is a Discord bot designed
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Getting Started
|
### 1.1. Getting Started
|
||||||
|
|
||||||
The Art for Palestine Bot is available on the [Art for Palestine Discord server](https://discord.gg/kHNyb6Vyf8). Once you join the server, you will automatically be assigned the member role and can begin interacting with the bot's features.
|
The Art for Palestine Bot is available on the [Art for Palestine Discord server](https://discord.gg/kHNyb6Vyf8). Once you join the server, you will automatically be assigned the member role and can begin interacting with the bot's features.
|
||||||
|
|
||||||
### 1.2 Requesting Art Commissions
|
### 1.2. Requesting Art Commissions
|
||||||
|
|
||||||
Art commission requests are submitted through an Airtable form (external to Discord). Once submitted, your request will automatically appear in the designated commission channel where artists can view and claim it. Your request should include:
|
Art commission requests are submitted through an Airtable form (external to Discord). Once submitted, your request will automatically appear in the designated commission channel where artists can view and claim it. Your request should include:
|
||||||
|
|
||||||
@@ -23,9 +23,9 @@ Art commission requests are submitted through an Airtable form (external to Disc
|
|||||||
- Reference images (optional)
|
- Reference images (optional)
|
||||||
- Any additional notes or requirements
|
- Any additional notes or requirements
|
||||||
|
|
||||||
### 1.3 Artist Features
|
### 1.3. Artist Features
|
||||||
|
|
||||||
#### 1.3.1 Claiming Art Commissions
|
#### 1.3.1. Claiming Art Commissions
|
||||||
|
|
||||||
As an artist, you can claim art commissions by reacting to commission posts in the art commission channel (ID: `1172568787330019340`).
|
As an artist, you can claim art commissions by reacting to commission posts in the art commission channel (ID: `1172568787330019340`).
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ As an artist, you can claim art commissions by reacting to commission posts in t
|
|||||||
- Claiming a commission creates a private thread for coordination
|
- Claiming a commission creates a private thread for coordination
|
||||||
- The thread will include your mention and the requester's information
|
- The thread will include your mention and the requester's information
|
||||||
|
|
||||||
#### 1.3.2 Submitting Completed Artwork
|
#### 1.3.2. Submitting Completed Artwork
|
||||||
|
|
||||||
Once you've completed the artwork:
|
Once you've completed the artwork:
|
||||||
1. Post the completed artwork as an image attachment in the private thread
|
1. Post the completed artwork as an image attachment in the private thread
|
||||||
@@ -42,36 +42,36 @@ Once you've completed the artwork:
|
|||||||
3. Your thread will be archived
|
3. Your thread will be archived
|
||||||
4. The commission will be removed from your active count
|
4. The commission will be removed from your active count
|
||||||
|
|
||||||
#### 1.3.3 Art Reminders
|
#### 1.3.3. Art Reminders
|
||||||
|
|
||||||
The bot sends automated reminders to help manage workload:
|
The bot sends automated reminders to help manage workload:
|
||||||
- **Unclaimed Art Reminders**: Sent Monday, Wednesday, and Friday at 9:00 AM
|
- **Unclaimed Art Reminders**: Sent Monday, Wednesday, and Friday at 9:00 AM
|
||||||
- **Unfinished Art Reminders**: Sent Saturday at 9:00 AM
|
- **Unfinished Art Reminders**: Sent Saturday at 9:00 AM
|
||||||
|
|
||||||
### 1.4 Distribution Features
|
### 1.4. Distribution Features
|
||||||
|
|
||||||
#### 1.4.1 Claiming Distributions
|
#### 1.4.1. Claiming Distributions
|
||||||
|
|
||||||
Distribution team members can claim distribution tasks by reacting to posts in the distribution channel (ID: `1173061747737903315`). Similar to art commissions:
|
Distribution team members can claim distribution tasks by reacting to posts in the distribution channel (ID: `1173061747737903315`). Similar to art commissions:
|
||||||
- Maximum 2 concurrent distributions per member
|
- Maximum 2 concurrent distributions per member
|
||||||
- Creates a private coordination thread
|
- Creates a private coordination thread
|
||||||
- Includes recipient and artwork details
|
- Includes recipient and artwork details
|
||||||
|
|
||||||
#### 1.4.2 Confirming Deliveries
|
#### 1.4.2. Confirming Deliveries
|
||||||
|
|
||||||
To confirm a distribution:
|
To confirm a distribution:
|
||||||
1. Deliver the artwork to the recipient
|
1. Deliver the artwork to the recipient
|
||||||
2. Post a confirmation image in the private thread
|
2. Post a confirmation image in the private thread
|
||||||
3. The bot will close and archive the thread
|
3. The bot will close and archive the thread
|
||||||
|
|
||||||
#### 1.4.3 Distribution Reminders
|
#### 1.4.3. Distribution Reminders
|
||||||
|
|
||||||
- **Unclaimed Distribution Reminders**: Sent Monday, Wednesday, and Friday at 9:00 AM
|
- **Unclaimed Distribution Reminders**: Sent Monday, Wednesday, and Friday at 9:00 AM
|
||||||
- **Unfinished Distribution Reminders**: Sent Saturday at 9:00 AM
|
- **Unfinished Distribution Reminders**: Sent Saturday at 9:00 AM
|
||||||
|
|
||||||
### 1.5 Support Ticket System
|
### 1.5. Support Ticket System
|
||||||
|
|
||||||
#### 1.5.1 Opening a Ticket
|
#### 1.5.1. Opening a Ticket
|
||||||
|
|
||||||
Users can open support tickets using the ticket button in the designated ticket channel:
|
Users can open support tickets using the ticket button in the designated ticket channel:
|
||||||
1. Click the "Open Ticket" button
|
1. Click the "Open Ticket" button
|
||||||
@@ -79,20 +79,20 @@ Users can open support tickets using the ticket button in the designated ticket
|
|||||||
3. A private thread will be created for your ticket
|
3. A private thread will be created for your ticket
|
||||||
4. Support team members will be notified
|
4. Support team members will be notified
|
||||||
|
|
||||||
#### 1.5.2 Ticket Workflow
|
#### 1.5.2. Ticket Workflow
|
||||||
|
|
||||||
- **For Users**: Describe your issue in the private thread and wait for a support team member to claim it
|
- **For Users**: Describe your issue in the private thread and wait for a support team member to claim it
|
||||||
- **For Support Team**: Click "Claim Ticket" to add your mention and take responsibility for the issue
|
- **For Support Team**: Click "Claim Ticket" to add your mention and take responsibility for the issue
|
||||||
- Conversations in the ticket thread are automatically logged
|
- Conversations in the ticket thread are automatically logged
|
||||||
|
|
||||||
#### 1.5.3 Closing Tickets
|
#### 1.5.3. Closing Tickets
|
||||||
|
|
||||||
Support team members can close tickets using the "Close Ticket" button:
|
Support team members can close tickets using the "Close Ticket" button:
|
||||||
- A log file of the entire conversation will be generated
|
- A log file of the entire conversation will be generated
|
||||||
- The log is sent to the ticket archive channel
|
- The log is sent to the ticket archive channel
|
||||||
- The thread is closed and archived
|
- The thread is closed and archived
|
||||||
|
|
||||||
### 1.6 Moderation Commands
|
### 1.6. Moderation Commands
|
||||||
|
|
||||||
Moderation team members with the support role (ID: `1173582640843063366`) have access to these commands:
|
Moderation team members with the support role (ID: `1173582640843063366`) have access to these commands:
|
||||||
|
|
||||||
@@ -122,19 +122,19 @@ Remove a timeout from a user.
|
|||||||
!unmute 123456789012345678 Appeal accepted
|
!unmute 123456789012345678 Appeal accepted
|
||||||
```
|
```
|
||||||
|
|
||||||
### 1.7 Palestine News Updates
|
### 1.7. Palestine News Updates
|
||||||
|
|
||||||
The bot automatically fetches and posts news updates from Al Jazeera's Palestine live blog:
|
The bot automatically fetches and posts news updates from Al Jazeera's Palestine live blog:
|
||||||
- Updates are checked every 10 minutes
|
- Updates are checked every 10 minutes
|
||||||
- New articles are posted to the news channel
|
- New articles are posted to the news channel
|
||||||
- Prevents duplicate posts using article ID tracking
|
- Prevents duplicate posts using article ID tracking
|
||||||
|
|
||||||
### 1.8 Getting Help
|
### 1.8. Getting Help
|
||||||
|
|
||||||
If you encounter issues or have questions:
|
If you encounter issues or have questions:
|
||||||
- Open a support ticket in the Discord server
|
- Open a support ticket in the Discord server
|
||||||
- Report bugs on [GitHub Issues](https://github.com/naomi-lgbt/nodejs-typescript-template/issues)
|
- Report bugs in the #bug-reports forum channel on our Discord community
|
||||||
- Contact via the [chat server](http://chat.nhcarrigan.com) or email at `contact@nhcarrigan.com`
|
- Contact via the [chat server](https://chat.nhcarrigan.com) or email at `contact@nhcarrigan.com`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -142,7 +142,7 @@ If you encounter issues or have questions:
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Prerequisites
|
### 2.1. Prerequisites
|
||||||
|
|
||||||
Before running your own instance, ensure you have:
|
Before running your own instance, ensure you have:
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ Before running your own instance, ensure you have:
|
|||||||
- **Airtable Account**: With API access
|
- **Airtable Account**: With API access
|
||||||
- **Discord Webhooks**: Multiple webhooks configured for different channels
|
- **Discord Webhooks**: Multiple webhooks configured for different channels
|
||||||
|
|
||||||
### 2.2 Required Discord Permissions
|
### 2.2. Required Discord Permissions
|
||||||
|
|
||||||
Your Discord bot requires the following Gateway Intents:
|
Your Discord bot requires the following Gateway Intents:
|
||||||
- `GuildMessages`: Access to guild message events
|
- `GuildMessages`: Access to guild message events
|
||||||
@@ -161,7 +161,7 @@ Your Discord bot requires the following Gateway Intents:
|
|||||||
- `MessageContent`: Privileged intent for full message content access
|
- `MessageContent`: Privileged intent for full message content access
|
||||||
- `GuildMembers`: Access to member data
|
- `GuildMembers`: Access to member data
|
||||||
|
|
||||||
### 2.3 Environment Configuration
|
### 2.3. Environment Configuration
|
||||||
|
|
||||||
Create a `.env` file in the project root with the following variables:
|
Create a `.env` file in the project root with the following variables:
|
||||||
|
|
||||||
@@ -185,7 +185,7 @@ AIRTABLE_TABLE_ID=your_table_name
|
|||||||
NODE_ENV=production # Set to enable HTTPS server on port 10443
|
NODE_ENV=production # Set to enable HTTPS server on port 10443
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.4 Hardcoded Configuration
|
### 2.4. Hardcoded Configuration
|
||||||
|
|
||||||
Several IDs are hardcoded in the `src/config/` directory and must be updated for your server:
|
Several IDs are hardcoded in the `src/config/` directory and must be updated for your server:
|
||||||
|
|
||||||
@@ -200,11 +200,11 @@ Several IDs are hardcoded in the `src/config/` directory and must be updated for
|
|||||||
**File: `src/config/Trello.ts`**
|
**File: `src/config/Trello.ts`**
|
||||||
- Trello board, list, and label IDs (if using Trello integration)
|
- Trello board, list, and label IDs (if using Trello integration)
|
||||||
|
|
||||||
### 2.5 Installation
|
### 2.5. Installation
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/naomi-lgbt/nodejs-typescript-template.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/a4p-bot.git
|
||||||
cd nodejs-typescript-template
|
cd nodejs-typescript-template
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ pnpm install
|
|||||||
pnpm build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.6 Running the Bot
|
### 2.6. Running the Bot
|
||||||
|
|
||||||
Start the bot in production mode:
|
Start the bot in production mode:
|
||||||
```bash
|
```bash
|
||||||
@@ -234,7 +234,7 @@ This will:
|
|||||||
- Initialize event listeners and scheduled tasks
|
- Initialize event listeners and scheduled tasks
|
||||||
- Start the HTTP server on port 10080 (HTTP) or 10443 (HTTPS if `NODE_ENV=production`)
|
- Start the HTTP server on port 10080 (HTTP) or 10443 (HTTPS if `NODE_ENV=production`)
|
||||||
|
|
||||||
### 2.7 Development Workflow
|
### 2.7. Development Workflow
|
||||||
|
|
||||||
For development and testing:
|
For development and testing:
|
||||||
|
|
||||||
@@ -256,9 +256,9 @@ pnpm build
|
|||||||
```
|
```
|
||||||
Compiles TypeScript files from `src/` to JavaScript in `prod/`.
|
Compiles TypeScript files from `src/` to JavaScript in `prod/`.
|
||||||
|
|
||||||
### 2.8 Architecture Overview
|
### 2.8. Architecture Overview
|
||||||
|
|
||||||
#### 2.8.1 Project Structure
|
#### 2.8.1. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
a4p-bot/
|
a4p-bot/
|
||||||
@@ -279,7 +279,7 @@ a4p-bot/
|
|||||||
└── .env # Environment variables (not committed)
|
└── .env # Environment variables (not committed)
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2.8.2 Core Components
|
#### 2.8.2. Core Components
|
||||||
|
|
||||||
**Discord Bot (src/index.ts:1)**
|
**Discord Bot (src/index.ts:1)**
|
||||||
- Initializes Discord.js client with required intents
|
- Initializes Discord.js client with required intents
|
||||||
@@ -319,7 +319,7 @@ a4p-bot/
|
|||||||
- Tracks last posted article ID to prevent duplicates
|
- Tracks last posted article ID to prevent duplicates
|
||||||
- Sends new updates to news webhook channel
|
- Sends new updates to news webhook channel
|
||||||
|
|
||||||
#### 2.8.3 Data Flow
|
#### 2.8.3. Data Flow
|
||||||
|
|
||||||
```
|
```
|
||||||
User Action (Discord) → Event Listener → Event Handler → Module Logic
|
User Action (Discord) → Event Listener → Event Handler → Module Logic
|
||||||
@@ -339,7 +339,7 @@ Scheduled Task → External API (Airtable/Al Jazeera) → Parse Response
|
|||||||
Update Cache/State
|
Update Cache/State
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.9 Database
|
### 2.9. Database
|
||||||
|
|
||||||
While Prisma ORM is installed as a dependency, the Application does not currently use a database. All state is managed in memory using cache objects attached to the extended Discord client:
|
While Prisma ORM is installed as a dependency, the Application does not currently use a database. All state is managed in memory using cache objects attached to the extended Discord client:
|
||||||
|
|
||||||
@@ -348,9 +348,9 @@ While Prisma ORM is installed as a dependency, the Application does not currentl
|
|||||||
|
|
||||||
Ticket conversation logs are temporarily stored as text files in the `logs/` directory and deleted after being sent to the archive channel.
|
Ticket conversation logs are temporarily stored as text files in the `logs/` directory and deleted after being sent to the archive channel.
|
||||||
|
|
||||||
### 2.10 API Integrations
|
### 2.10. API Integrations
|
||||||
|
|
||||||
#### 2.10.1 Airtable REST API
|
#### 2.10.1. Airtable REST API
|
||||||
|
|
||||||
**Endpoint:** `https://api.airtable.com/v0/{BASE_ID}/{TABLE_ID}`
|
**Endpoint:** `https://api.airtable.com/v0/{BASE_ID}/{TABLE_ID}`
|
||||||
|
|
||||||
@@ -384,7 +384,7 @@ Authorization: Bearer {AIRTABLE_KEY}
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2.10.2 Al Jazeera GraphQL API
|
#### 2.10.2. Al Jazeera GraphQL API
|
||||||
|
|
||||||
**Endpoint:** `https://www.aljazeera.com/graphql` (inferred from code)
|
**Endpoint:** `https://www.aljazeera.com/graphql` (inferred from code)
|
||||||
|
|
||||||
@@ -394,7 +394,7 @@ Authorization: Bearer {AIRTABLE_KEY}
|
|||||||
|
|
||||||
The bot extracts article content and posts to the news webhook channel.
|
The bot extracts article content and posts to the news webhook channel.
|
||||||
|
|
||||||
### 2.11 HTTP Server
|
### 2.11. HTTP Server
|
||||||
|
|
||||||
The Application includes a minimal Express server (src/server/serve.ts:1):
|
The Application includes a minimal Express server (src/server/serve.ts:1):
|
||||||
|
|
||||||
@@ -407,7 +407,7 @@ The Application includes a minimal Express server (src/server/serve.ts:1):
|
|||||||
|
|
||||||
Note: The server file includes a TODO comment suggesting deletion after Trello integration is complete.
|
Note: The server file includes a TODO comment suggesting deletion after Trello integration is complete.
|
||||||
|
|
||||||
### 2.12 Logging
|
### 2.12. Logging
|
||||||
|
|
||||||
The Application uses Winston for structured logging (src/utils/logHandler.ts:1):
|
The Application uses Winston for structured logging (src/utils/logHandler.ts:1):
|
||||||
|
|
||||||
@@ -424,7 +424,7 @@ The Application uses Winston for structured logging (src/utils/logHandler.ts:1):
|
|||||||
- Console (stdout)
|
- Console (stdout)
|
||||||
- Debug webhook (errors only)
|
- Debug webhook (errors only)
|
||||||
|
|
||||||
### 2.13 Error Handling
|
### 2.13. Error Handling
|
||||||
|
|
||||||
All errors are caught and:
|
All errors are caught and:
|
||||||
1. Logged to console via Winston
|
1. Logged to console via Winston
|
||||||
@@ -441,7 +441,7 @@ try {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.14 Performance Considerations
|
### 2.14. Performance Considerations
|
||||||
|
|
||||||
- **Message Caching**: Fetches messages in batches of 100 to reduce API calls
|
- **Message Caching**: Fetches messages in batches of 100 to reduce API calls
|
||||||
- **Duplicate Prevention**: Tracks latest Airtable record ID and news article ID
|
- **Duplicate Prevention**: Tracks latest Airtable record ID and news article ID
|
||||||
@@ -450,14 +450,14 @@ try {
|
|||||||
- News API: 10-minute polling interval
|
- News API: 10-minute polling interval
|
||||||
- **Concurrent Limits**: Artists/distributors limited to 2 active tasks each
|
- **Concurrent Limits**: Artists/distributors limited to 2 active tasks each
|
||||||
|
|
||||||
### 2.15 Security Considerations
|
### 2.15. Security Considerations
|
||||||
|
|
||||||
- **Environment Variables**: Sensitive tokens stored in `.env` (not committed)
|
- **Environment Variables**: Sensitive tokens stored in `.env` (not committed)
|
||||||
- **Role Verification**: Commands require support role for execution (src/events/onMessageCreate.ts:1)
|
- **Role Verification**: Commands require support role for execution (src/events/onMessageCreate.ts:1)
|
||||||
- **Webhook Validation**: Checks webhook existence before use (src/utils/isValidWebhook.ts:1)
|
- **Webhook Validation**: Checks webhook existence before use (src/utils/isValidWebhook.ts:1)
|
||||||
- **Privileged Intents**: Requires approval from Discord for `MessageContent` intent
|
- **Privileged Intents**: Requires approval from Discord for `MessageContent` intent
|
||||||
|
|
||||||
### 2.16 Troubleshooting
|
### 2.16. Troubleshooting
|
||||||
|
|
||||||
**Bot doesn't start:**
|
**Bot doesn't start:**
|
||||||
- Verify `TOKEN` is valid in `.env`
|
- Verify `TOKEN` is valid in `.env`
|
||||||
@@ -490,19 +490,19 @@ try {
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 Terms of Service
|
### 3.1. Terms of Service
|
||||||
|
|
||||||
The Application is subject to our global Terms of Service, which can be found at:
|
The Application is subject to our global Terms of Service, which can be found at:
|
||||||
|
|
||||||
https://docs.nhcarrigan.com/#/terms
|
https://docs.nhcarrigan.com/#/terms
|
||||||
|
|
||||||
### 3.2 Privacy Policy
|
### 3.2. Privacy Policy
|
||||||
|
|
||||||
The Application's privacy practices are governed by our global Privacy Policy, which can be found at:
|
The Application's privacy practices are governed by our global Privacy Policy, which can be found at:
|
||||||
|
|
||||||
https://docs.nhcarrigan.com/#/privacy
|
https://docs.nhcarrigan.com/#/privacy
|
||||||
|
|
||||||
#### 3.2.1 Data Collection
|
#### 3.2.1. Data Collection
|
||||||
|
|
||||||
The Application collects and temporarily stores the following data:
|
The Application collects and temporarily stores the following data:
|
||||||
|
|
||||||
@@ -535,9 +535,9 @@ The Application integrates with:
|
|||||||
|
|
||||||
Users should review the privacy policies of these services for their data handling practices.
|
Users should review the privacy policies of these services for their data handling practices.
|
||||||
|
|
||||||
### 3.3 License
|
### 3.3. License
|
||||||
|
|
||||||
This software is licensed under our global software license:
|
This software is licensed under our global software licence:
|
||||||
|
|
||||||
https://docs.nhcarrigan.com/#/license
|
https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
@@ -545,23 +545,23 @@ https://docs.nhcarrigan.com/#/license
|
|||||||
|
|
||||||
**License Type:** Proprietary (see link above for full terms)
|
**License Type:** Proprietary (see link above for full terms)
|
||||||
|
|
||||||
### 3.4 Code of Conduct
|
### 3.4. Code of Conduct
|
||||||
|
|
||||||
All contributors and users must adhere to our Code of Conduct:
|
All contributors and users must adhere to our Code of Conduct:
|
||||||
|
|
||||||
See: `CODE_OF_CONDUCT.md` in the repository root
|
See: `CODE_OF_CONDUCT.md` in the repository root
|
||||||
|
|
||||||
### 3.5 Security Policy
|
### 3.5. Security Policy
|
||||||
|
|
||||||
Security vulnerabilities should be reported according to our Security Policy:
|
Security vulnerabilities should be reported according to our Security Policy:
|
||||||
|
|
||||||
See: `SECURITY.md` in the repository root
|
See: `SECURITY.md` in the repository root
|
||||||
|
|
||||||
For security concerns, please contact us through:
|
For security concerns, please contact us through:
|
||||||
- Chat Server: http://chat.nhcarrigan.com
|
- Chat Server: https://chat.nhcarrigan.com
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
### 3.6 Disclaimer
|
### 3.6. Disclaimer
|
||||||
|
|
||||||
The Application is provided for the specific purpose of facilitating the Art for Palestine charity event. While we strive for reliability and accuracy, the Application is provided "as-is" without warranties of any kind.
|
The Application is provided for the specific purpose of facilitating the Art for Palestine charity event. While we strive for reliability and accuracy, the Application is provided "as-is" without warranties of any kind.
|
||||||
|
|
||||||
@@ -577,13 +577,13 @@ The Application is provided for the specific purpose of facilitating the Art for
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Our complete contributing guidelines can be found at:
|
Our complete contributing guidelines can be found at:
|
||||||
|
|
||||||
https://docs.nhcarrigan.com/#/contributing
|
https://docs.nhcarrigan.com/#/contributing
|
||||||
|
|
||||||
### 4.2 Getting Started with Development
|
### 4.2. Getting Started with Development
|
||||||
|
|
||||||
1. **Fork the Repository**
|
1. **Fork the Repository**
|
||||||
```bash
|
```bash
|
||||||
@@ -611,7 +611,7 @@ https://docs.nhcarrigan.com/#/contributing
|
|||||||
git checkout -b feature/your-feature-name
|
git checkout -b feature/your-feature-name
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.3 Code Style and Standards
|
### 4.3. Code Style and Standards
|
||||||
|
|
||||||
The project enforces code style through automated tooling:
|
The project enforces code style through automated tooling:
|
||||||
|
|
||||||
@@ -644,7 +644,7 @@ npx eslint src test --fix
|
|||||||
npx prettier src test --write
|
npx prettier src test --write
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.4 Writing Tests
|
### 4.4. Writing Tests
|
||||||
|
|
||||||
The project uses Mocha and Chai for testing:
|
The project uses Mocha and Chai for testing:
|
||||||
|
|
||||||
@@ -678,7 +678,7 @@ suite("Feature Name", () => {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.5 Documentation Standards
|
### 4.5. Documentation Standards
|
||||||
|
|
||||||
**JSDoc Comments:**
|
**JSDoc Comments:**
|
||||||
All functions, classes, and complex logic should include JSDoc comments:
|
All functions, classes, and complex logic should include JSDoc comments:
|
||||||
@@ -711,7 +711,7 @@ Follow conventional commit format:
|
|||||||
- `refactor: Restructure event handlers`
|
- `refactor: Restructure event handlers`
|
||||||
- `test: Add tests for webhook validation`
|
- `test: Add tests for webhook validation`
|
||||||
|
|
||||||
### 4.6 Pull Request Process
|
### 4.6. Pull Request Process
|
||||||
|
|
||||||
1. **Ensure All Checks Pass:**
|
1. **Ensure All Checks Pass:**
|
||||||
- Run `pnpm lint` (must pass with 0 warnings)
|
- Run `pnpm lint` (must pass with 0 warnings)
|
||||||
@@ -733,7 +733,7 @@ Follow conventional commit format:
|
|||||||
- Maintainers will merge approved PRs
|
- Maintainers will merge approved PRs
|
||||||
- Squash and merge is preferred for clean history
|
- Squash and merge is preferred for clean history
|
||||||
|
|
||||||
### 4.7 Areas for Contribution
|
### 4.7. Areas for Contribution
|
||||||
|
|
||||||
The project welcomes contributions in these areas:
|
The project welcomes contributions in these areas:
|
||||||
|
|
||||||
@@ -744,7 +744,7 @@ The project welcomes contributions in these areas:
|
|||||||
- Enhanced reporting and analytics
|
- Enhanced reporting and analytics
|
||||||
|
|
||||||
**Bug Fixes:**
|
**Bug Fixes:**
|
||||||
- Report bugs via GitHub Issues
|
- Report bugs in the #bug-reports forum channel on our Discord community
|
||||||
- Include reproduction steps and environment details
|
- Include reproduction steps and environment details
|
||||||
- PRs to fix bugs are highly appreciated
|
- PRs to fix bugs are highly appreciated
|
||||||
|
|
||||||
@@ -760,11 +760,11 @@ The project welcomes contributions in these areas:
|
|||||||
- Create test utilities
|
- Create test utilities
|
||||||
|
|
||||||
**Performance:**
|
**Performance:**
|
||||||
- Optimize message caching
|
- Optimise message caching
|
||||||
- Reduce webhook API calls
|
- Reduce webhook API calls
|
||||||
- Improve scheduled task efficiency
|
- Improve scheduled task efficiency
|
||||||
|
|
||||||
### 4.8 Development Environment Setup
|
### 4.8. Development Environment Setup
|
||||||
|
|
||||||
**Recommended Tools:**
|
**Recommended Tools:**
|
||||||
- **Editor:** VS Code (or any TypeScript-compatible editor)
|
- **Editor:** VS Code (or any TypeScript-compatible editor)
|
||||||
@@ -788,7 +788,7 @@ The project welcomes contributions in these areas:
|
|||||||
3. Create webhooks for: debug, comm, dist, news, ticket
|
3. Create webhooks for: debug, comm, dist, news, ticket
|
||||||
4. Copy webhook URLs to `.env`
|
4. Copy webhook URLs to `.env`
|
||||||
|
|
||||||
### 4.9 Debugging
|
### 4.9. Debugging
|
||||||
|
|
||||||
**Console Logging:**
|
**Console Logging:**
|
||||||
The project uses Winston for logging. To add debug logs:
|
The project uses Winston for logging. To add debug logs:
|
||||||
@@ -822,7 +822,7 @@ Create `.vscode/launch.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.10 Common Development Tasks
|
### 4.10. Common Development Tasks
|
||||||
|
|
||||||
**Adding a New Command:**
|
**Adding a New Command:**
|
||||||
1. Add handler logic to `src/events/onMessageCreate.ts`
|
1. Add handler logic to `src/events/onMessageCreate.ts`
|
||||||
@@ -847,7 +847,7 @@ Create `.vscode/launch.json`:
|
|||||||
2. Document changes in section 2.4
|
2. Document changes in section 2.4
|
||||||
3. Update environment variable documentation if needed
|
3. Update environment variable documentation if needed
|
||||||
|
|
||||||
### 4.11 Release Process
|
### 4.11. Release Process
|
||||||
|
|
||||||
(For maintainers)
|
(For maintainers)
|
||||||
|
|
||||||
@@ -875,18 +875,14 @@ Create `.vscode/launch.json`:
|
|||||||
git push origin v2.0.0
|
git push origin v2.0.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.12 Contact for Contributors
|
### 4.12. Contact for Contributors
|
||||||
|
|
||||||
If you have questions about contributing:
|
If you have questions about contributing:
|
||||||
|
|
||||||
- **GitHub Issues:** https://github.com/naomi-lgbt/nodejs-typescript-template/issues
|
- **Discord Forum:** Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- **Chat Server:** http://chat.nhcarrigan.com
|
- **Chat Server:** https://chat.nhcarrigan.com
|
||||||
- **Email:** contact@nhcarrigan.com
|
- **Email:** contact@nhcarrigan.com
|
||||||
|
|
||||||
We review pull requests as soon as possible and appreciate all contributions to the project.
|
We review pull requests as soon as possible and appreciate all contributions to the project.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Document Version:** 1.0.0
|
|
||||||
**Last Updated:** 2025-10-29
|
|
||||||
**Maintained By:** Naomi Carrigan
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ Altaria is a friendly Discord bot designed to encourage the use of alt-text (alt
|
|||||||
|
|
||||||
### How to Add Altaria to Your Server
|
### How to Add Altaria to Your Server
|
||||||
|
|
||||||
1. Use the official invitation link: [Add to Discord](https://discord.com/oauth2/authorize?client_id=1405356559214837860)
|
1. Use the official invitation link: [Add to Discord](https://discord.com/oauth2/authorise?client_id=1405356559214837860)
|
||||||
2. Select your server from the dropdown menu
|
2. Select your server from the dropdown menu
|
||||||
3. Grant the necessary permissions:
|
3. Grant the necessary permissions:
|
||||||
- Read Messages/View Channels
|
- Read Messages/View Channels
|
||||||
@@ -39,7 +39,7 @@ Altaria's reminders fall into five themed categories:
|
|||||||
1. **Gentle Encouragement** (20 messages) - Soft, supportive reminders
|
1. **Gentle Encouragement** (20 messages) - Soft, supportive reminders
|
||||||
2. **Playful/Cute** (20 messages) - Fun, anime-inspired messages with emoticons
|
2. **Playful/Cute** (20 messages) - Fun, anime-inspired messages with emoticons
|
||||||
3. **Educational** (20 messages) - Informative content about accessibility
|
3. **Educational** (20 messages) - Informative content about accessibility
|
||||||
4. **Community Vibes** (20 messages) - Emphasizing collective responsibility
|
4. **Community Vibes** (20 messages) - Emphasising collective responsibility
|
||||||
5. **Thematic/Fantasy** (20 messages) - Creative, story-driven reminders
|
5. **Thematic/Fantasy** (20 messages) - Creative, story-driven reminders
|
||||||
|
|
||||||
### Getting Help
|
### Getting Help
|
||||||
@@ -130,7 +130,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. Full details available at: https://docs.nhcarrigan.com/#/license
|
This software is licensed under Naomi's Public Licence. Full details available at: https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
|
|
||||||
@@ -153,7 +153,7 @@ Copyright held by Naomi Carrigan (@nhcarrigan).
|
|||||||
### Terms of Use
|
### Terms of Use
|
||||||
|
|
||||||
By adding Altaria to your Discord server, you agree to:
|
By adding Altaria to your Discord server, you agree to:
|
||||||
- Allow the bot to read messages in authorized channels
|
- Allow the bot to read messages in authorised channels
|
||||||
- Accept that the bot will send reminder messages about alt-text
|
- Accept that the bot will send reminder messages about alt-text
|
||||||
- Understand that the bot promotes accessibility and inclusion
|
- Understand that the bot promotes accessibility and inclusion
|
||||||
|
|
||||||
@@ -213,10 +213,9 @@ To add new reminder messages to `src/config/reminders.ts:9`:
|
|||||||
### Contact for Contributors
|
### Contact for Contributors
|
||||||
|
|
||||||
- **Discord**: [Chat Server](https://chat.nhcarrigan.com)
|
- **Discord**: [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- **Forum**: [Discussion Forum](https://forum.nhcarrigan.com)
|
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
- **Issues**: GitHub Issues for bug reports and feature requests
|
- **Issues**: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
|
|
||||||
### Recognition
|
### Recognition
|
||||||
|
|
||||||
Contributors will be recognized in future releases and project documentation as appropriate.
|
Contributors will be recognised in future releases and project documentation as appropriate.
|
||||||
|
|||||||
@@ -2,29 +2,29 @@
|
|||||||
title: Amari
|
title: Amari
|
||||||
---
|
---
|
||||||
|
|
||||||
Amari (hereinafter the "Application") is Naomi's Virtual Personal Assistant on Discord, designed to automate community management, content aggregation, mentorship program coordination, and integration with external services such as GitHub, RetroAchievements, and Baserow.
|
Amari (hereinafter the "Application") is Naomi's Virtual Personal Assistant on Discord, designed to automate community management, content aggregation, mentorship programme coordination, and integration with external services such as GitHub, RetroAchievements, and Baserow.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Interacting with Amari
|
### 1.1. Interacting with Amari
|
||||||
|
|
||||||
#### 1.1.1 Direct Messages
|
#### 1.1.1. Direct Messages
|
||||||
|
|
||||||
When you send a Direct Message to Amari, the bot will automatically forward your message to Naomi and respond with an acknowledgment. This provides a direct communication channel to reach Naomi through the bot.
|
When you send a Direct Message to Amari, the bot will automatically forward your message to Naomi and respond with an acknowledgment. This provides a direct communication channel to reach Naomi through the bot.
|
||||||
|
|
||||||
Implementation: `src/modules/respondToDm.ts:19`
|
Implementation: `src/modules/respondToDm.ts:19`
|
||||||
|
|
||||||
#### 1.1.2 Mentions
|
#### 1.1.2. Mentions
|
||||||
|
|
||||||
Amari monitors messages in the Discord server for mentions of "Naomi" or "@NHCarrigan" (user or role). When detected, the bot forwards the message to Naomi for review, helping ensure important messages are not missed. To prevent spam, Amari will not forward mentions from channels that have been active in the last 10 minutes.
|
Amari monitors messages in the Discord server for mentions of "Naomi" or "@nhcarrigan" (user or role). When detected, the bot forwards the message to Naomi for review, helping ensure important messages are not missed. To prevent spam, Amari will not forward mentions from channels that have been active in the last 10 minutes.
|
||||||
|
|
||||||
Implementation: `src/modules/respondToMention.ts:20`
|
Implementation: `src/modules/respondToMention.ts:20`
|
||||||
|
|
||||||
### 1.2 Mentorship Program
|
### 1.2. Mentorship Program
|
||||||
|
|
||||||
#### 1.2.1 Joining the Program
|
#### 1.2.1. Joining the Program
|
||||||
|
|
||||||
When you receive the Mentorship role, Amari will automatically send a welcome message in the mentee chat channel with onboarding instructions, including:
|
When you receive the Mentorship role, Amari will automatically send a welcome message in the mentee chat channel with onboarding instructions, including:
|
||||||
- Accepting the GitHub repository invitation
|
- Accepting the GitHub repository invitation
|
||||||
@@ -33,7 +33,7 @@ When you receive the Mentorship role, Amari will automatically send a welcome me
|
|||||||
|
|
||||||
Implementation: `src/modules/processMentorshipRole.ts:20`
|
Implementation: `src/modules/processMentorshipRole.ts:20`
|
||||||
|
|
||||||
#### 1.2.2 Forum Thread Management
|
#### 1.2.2. Forum Thread Management
|
||||||
|
|
||||||
Amari automatically manages thread tags in mentorship forums (Goals, Projects, Resume Reviews, and Discussions) to track whose turn it is to respond:
|
Amari automatically manages thread tags in mentorship forums (Goals, Projects, Resume Reviews, and Discussions) to track whose turn it is to respond:
|
||||||
- When Naomi responds to your thread, the tag changes to "Waiting on Member"
|
- When Naomi responds to your thread, the tag changes to "Waiting on Member"
|
||||||
@@ -41,7 +41,7 @@ Amari automatically manages thread tags in mentorship forums (Goals, Projects, R
|
|||||||
|
|
||||||
Implementation: `src/modules/updateMentorshipThread.ts:43`
|
Implementation: `src/modules/updateMentorshipThread.ts:43`
|
||||||
|
|
||||||
#### 1.2.3 Progress Reminders
|
#### 1.2.3. Progress Reminders
|
||||||
|
|
||||||
Every weekday (Monday-Friday) at 9:00 AM, Amari posts progress reminders in configured channels. These reminders prompt you to share:
|
Every weekday (Monday-Friday) at 9:00 AM, Amari posts progress reminders in configured channels. These reminders prompt you to share:
|
||||||
1. What you accomplished yesterday
|
1. What you accomplished yesterday
|
||||||
@@ -50,9 +50,9 @@ Every weekday (Monday-Friday) at 9:00 AM, Amari posts progress reminders in conf
|
|||||||
|
|
||||||
Implementation: `src/modules/postProgressReminders.ts:16`
|
Implementation: `src/modules/postProgressReminders.ts:16`
|
||||||
|
|
||||||
### 1.3 Content and News
|
### 1.3. Content and News
|
||||||
|
|
||||||
#### 1.3.1 Tech News Feed
|
#### 1.3.1. Tech News Feed
|
||||||
|
|
||||||
Amari automatically posts new articles from two sources every hour:
|
Amari automatically posts new articles from two sources every hour:
|
||||||
- **FreeCodeCamp News**: Articles are filtered for inappropriate content before posting
|
- **FreeCodeCamp News**: Articles are filtered for inappropriate content before posting
|
||||||
@@ -60,7 +60,7 @@ Amari automatically posts new articles from two sources every hour:
|
|||||||
|
|
||||||
Implementation: `src/modules/postNews.ts:40` and `src/modules/postNews.ts:95`
|
Implementation: `src/modules/postNews.ts:40` and `src/modules/postNews.ts:95`
|
||||||
|
|
||||||
#### 1.3.2 RetroAchievements
|
#### 1.3.2. RetroAchievements
|
||||||
|
|
||||||
If Naomi unlocks any RetroAchievements, Amari posts them to the gaming channel every 10 minutes. These posts include:
|
If Naomi unlocks any RetroAchievements, Amari posts them to the gaming channel every 10 minutes. These posts include:
|
||||||
- Achievement title and description
|
- Achievement title and description
|
||||||
@@ -70,7 +70,7 @@ If Naomi unlocks any RetroAchievements, Amari posts them to the gaming channel e
|
|||||||
|
|
||||||
Implementation: `src/modules/checkAchievements.ts:87`
|
Implementation: `src/modules/checkAchievements.ts:87`
|
||||||
|
|
||||||
### 1.4 Form Submissions
|
### 1.4. Form Submissions
|
||||||
|
|
||||||
When you submit a form through the Baserow system, Amari posts a notification to the form submissions channel. Supported forms include:
|
When you submit a form through the Baserow system, Amari posts a notification to the form submissions channel. Supported forms include:
|
||||||
- Sanction Appeals
|
- Sanction Appeals
|
||||||
@@ -93,7 +93,7 @@ Implementation: `src/modules/processFormSubmission.ts:22` and `src/config/forms.
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Prerequisites
|
### 2.1. Prerequisites
|
||||||
|
|
||||||
- Node.js (compatible with the version specified in package.json)
|
- Node.js (compatible with the version specified in package.json)
|
||||||
- pnpm 10.15.0 or higher
|
- pnpm 10.15.0 or higher
|
||||||
@@ -102,7 +102,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
- RetroAchievements API Key (optional, for achievements feature)
|
- RetroAchievements API Key (optional, for achievements feature)
|
||||||
- Baserow webhook secret (optional, for form submissions)
|
- Baserow webhook secret (optional, for form submissions)
|
||||||
|
|
||||||
### 2.2 Environment Variables
|
### 2.2. Environment Variables
|
||||||
|
|
||||||
The following environment variables must be configured:
|
The following environment variables must be configured:
|
||||||
|
|
||||||
@@ -115,7 +115,7 @@ The following environment variables must be configured:
|
|||||||
| `RA_KEY` | No | RetroAchievements API key |
|
| `RA_KEY` | No | RetroAchievements API key |
|
||||||
| `BASEROW_SECRET` | No | Secret for validating Baserow webhook payloads |
|
| `BASEROW_SECRET` | No | Secret for validating Baserow webhook payloads |
|
||||||
|
|
||||||
### 2.3 Installation
|
### 2.3. Installation
|
||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
@@ -137,40 +137,40 @@ The following environment variables must be configured:
|
|||||||
|
|
||||||
Implementation: `src/index.ts:1`
|
Implementation: `src/index.ts:1`
|
||||||
|
|
||||||
### 2.4 Configuration
|
### 2.4. Configuration
|
||||||
|
|
||||||
#### 2.4.1 Discord IDs
|
#### 2.4.1. Discord IDs
|
||||||
|
|
||||||
All Discord-specific IDs (channels, roles, users, guilds, tags) are configured in `src/config/ids.ts`. You will need to update these IDs to match your Discord server setup:
|
All Discord-specific IDs (channels, roles, users, guilds, tags) are configured in `src/config/ids.ts`. You will need to update these IDs to match your Discord server setup:
|
||||||
|
|
||||||
- **Channels**: Form submissions, gaming, general, mentee chat, forums, news
|
- **Channels**: Form submissions, gaming, general, mentee chat, forums, news
|
||||||
- **Roles**: Mentorship, nhcarrigan, representing
|
- **Roles**: Mentorship, NHCarrigan, representing
|
||||||
- **Users**: Amari (bot), Naomi, nhcarrigan
|
- **Users**: Amari (bot), Naomi, NHCarrigan
|
||||||
- **Tags**: Forum tags for tracking thread status
|
- **Tags**: Forum tags for tracking thread status
|
||||||
|
|
||||||
Implementation: `src/config/ids.ts:7`
|
Implementation: `src/config/ids.ts:7`
|
||||||
|
|
||||||
#### 2.4.2 Form IDs
|
#### 2.4.2. Form IDs
|
||||||
|
|
||||||
Form submission notifications are configured in `src/config/forms.ts`. Map Baserow table IDs to human-readable form names.
|
Form submission notifications are configured in `src/config/forms.ts`. Map Baserow table IDs to human-readable form names.
|
||||||
|
|
||||||
Implementation: `src/config/forms.ts:9`
|
Implementation: `src/config/forms.ts:9`
|
||||||
|
|
||||||
#### 2.4.3 Progress Reminders
|
#### 2.4.3. Progress Reminders
|
||||||
|
|
||||||
Progress reminder channels are configured in `src/config/progressReminders.ts`. Configure which channels should receive reminders, associated role IDs, and whether to create threads.
|
Progress reminder channels are configured in `src/config/progressReminders.ts`. Configure which channels should receive reminders, associated role IDs, and whether to create threads.
|
||||||
|
|
||||||
Implementation: `src/config/progressReminders.ts:1`
|
Implementation: `src/config/progressReminders.ts:1`
|
||||||
|
|
||||||
#### 2.4.4 DM Response
|
#### 2.4.4. DM Response
|
||||||
|
|
||||||
The automatic response sent when users DM the bot is configured in `src/config/responses.ts`.
|
The automatic response sent when users DM the bot is configured in `src/config/responses.ts`.
|
||||||
|
|
||||||
Implementation: `src/config/responses.ts:1`
|
Implementation: `src/config/responses.ts:1`
|
||||||
|
|
||||||
### 2.5 Architecture
|
### 2.5. Architecture
|
||||||
|
|
||||||
#### 2.5.1 Core Components
|
#### 2.5.1. Core Components
|
||||||
|
|
||||||
The Application consists of several key components:
|
The Application consists of several key components:
|
||||||
|
|
||||||
@@ -182,7 +182,7 @@ The Application consists of several key components:
|
|||||||
|
|
||||||
Main entry point: `src/index.ts:1`
|
Main entry point: `src/index.ts:1`
|
||||||
|
|
||||||
#### 2.5.2 Event Handlers
|
#### 2.5.2. Event Handlers
|
||||||
|
|
||||||
The bot responds to the following Discord events:
|
The bot responds to the following Discord events:
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ The bot responds to the following Discord events:
|
|||||||
- `GuildMemberAdd`: Log when mentees join (src/index.ts:125)
|
- `GuildMemberAdd`: Log when mentees join (src/index.ts:125)
|
||||||
- `GuildMemberRemove`: Log when mentees leave (src/index.ts:129)
|
- `GuildMemberRemove`: Log when mentees leave (src/index.ts:129)
|
||||||
|
|
||||||
#### 2.5.3 Scheduled Tasks
|
#### 2.5.3. Scheduled Tasks
|
||||||
|
|
||||||
The following tasks run on a schedule:
|
The following tasks run on a schedule:
|
||||||
|
|
||||||
@@ -205,7 +205,7 @@ The following tasks run on a schedule:
|
|||||||
|
|
||||||
Implementation: `src/index.ts:70-86`
|
Implementation: `src/index.ts:70-86`
|
||||||
|
|
||||||
#### 2.5.4 Web Server Endpoints
|
#### 2.5.4. Web Server Endpoints
|
||||||
|
|
||||||
The Fastify web server provides the following endpoints:
|
The Fastify web server provides the following endpoints:
|
||||||
|
|
||||||
@@ -217,7 +217,7 @@ The server listens on port 7044.
|
|||||||
|
|
||||||
Implementation: `src/server/serve.ts:61`
|
Implementation: `src/server/serve.ts:61`
|
||||||
|
|
||||||
### 2.6 Content Filtering
|
### 2.6. Content Filtering
|
||||||
|
|
||||||
FreeCodeCamp News posts are filtered for inappropriate content using a comprehensive regular expression that detects violations of the Code of Conduct. The regex is defined in `src/modules/postNews.ts:23` and checks for:
|
FreeCodeCamp News posts are filtered for inappropriate content using a comprehensive regular expression that detects violations of the Code of Conduct. The regex is defined in `src/modules/postNews.ts:23` and checks for:
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ FreeCodeCamp News posts are filtered for inappropriate content using a comprehen
|
|||||||
|
|
||||||
Posts matching these patterns are automatically rejected and not posted to Discord.
|
Posts matching these patterns are automatically rejected and not posted to Discord.
|
||||||
|
|
||||||
### 2.7 GitHub Integration
|
### 2.7. GitHub Integration
|
||||||
|
|
||||||
When GitHub webhooks are received:
|
When GitHub webhooks are received:
|
||||||
|
|
||||||
@@ -239,16 +239,16 @@ When GitHub webhooks are received:
|
|||||||
|
|
||||||
Implementation: `src/modules/processGitHubEvent.ts:31`
|
Implementation: `src/modules/processGitHubEvent.ts:31`
|
||||||
|
|
||||||
### 2.8 Development
|
### 2.8. Development
|
||||||
|
|
||||||
#### 2.8.1 Available Scripts
|
#### 2.8.1. Available Scripts
|
||||||
|
|
||||||
- `pnpm run build`: Compile TypeScript to JavaScript
|
- `pnpm run build`: Compile TypeScript to JavaScript
|
||||||
- `pnpm start`: Start the production server (uses 1Password for environment variables)
|
- `pnpm start`: Start the production server (uses 1Password for environment variables)
|
||||||
- `pnpm run lint`: Run ESLint with zero warnings policy
|
- `pnpm run lint`: Run ESLint with zero warnings policy
|
||||||
- `pnpm test`: Run tests (currently placeholder)
|
- `pnpm test`: Run tests (currently placeholder)
|
||||||
|
|
||||||
#### 2.8.2 Code Structure
|
#### 2.8.2. Code Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
src/
|
src/
|
||||||
@@ -261,7 +261,7 @@ src/
|
|||||||
└── index.ts # Application entry point
|
└── index.ts # Application entry point
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2.8.3 Dependencies
|
#### 2.8.3. Dependencies
|
||||||
|
|
||||||
Key dependencies:
|
Key dependencies:
|
||||||
- `discord.js` v14.22.0: Discord API wrapper
|
- `discord.js` v14.22.0: Discord API wrapper
|
||||||
@@ -277,21 +277,21 @@ Key dependencies:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. The full license text is available in the `LICENSE.md` file in the repository root.
|
This software is licensed under Naomi's Public Licence. The full licence text is available in the `LICENSE.md` file in the repository root.
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
### 3.2 Code of Conduct
|
### 3.2. Code of Conduct
|
||||||
|
|
||||||
All users interacting with the Application, whether through Discord or by contributing to the codebase, must adhere to the Code of Conduct defined in `CODE_OF_CONDUCT.md`.
|
All users interacting with the Application, whether through Discord or by contributing to the codebase, must adhere to the Code of Conduct defined in `CODE_OF_CONDUCT.md`.
|
||||||
|
|
||||||
### 3.3 Content Filtering
|
### 3.3. Content Filtering
|
||||||
|
|
||||||
The Application implements automated content filtering for RSS feeds to ensure posted content complies with the community's Code of Conduct. While this filtering attempts to catch policy violations, it may not be perfect. Users should report any inappropriate content that bypasses the filters.
|
The Application implements automated content filtering for RSS feeds to ensure posted content complies with the community's Code of Conduct. While this filtering attempts to catch policy violations, it may not be perfect. Users should report any inappropriate content that bypasses the filters.
|
||||||
|
|
||||||
### 3.4 Data Collection
|
### 3.4. Data Collection
|
||||||
|
|
||||||
The Application collects the following data for operational purposes:
|
The Application collects the following data for operational purposes:
|
||||||
|
|
||||||
@@ -302,7 +302,7 @@ The Application collects the following data for operational purposes:
|
|||||||
|
|
||||||
All data is processed in accordance with Naomi's privacy policies.
|
All data is processed in accordance with Naomi's privacy policies.
|
||||||
|
|
||||||
### 3.5 Third-Party Services
|
### 3.5. Third-Party Services
|
||||||
|
|
||||||
The Application integrates with several third-party services:
|
The Application integrates with several third-party services:
|
||||||
|
|
||||||
@@ -317,7 +317,7 @@ Users of the Application are subject to the terms of service of these platforms.
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Getting Started
|
### 4.1. Getting Started
|
||||||
|
|
||||||
Before contributing, please:
|
Before contributing, please:
|
||||||
|
|
||||||
@@ -325,7 +325,7 @@ Before contributing, please:
|
|||||||
2. Review the `CODE_OF_CONDUCT.md` to understand community standards
|
2. Review the `CODE_OF_CONDUCT.md` to understand community standards
|
||||||
3. Familiarize yourself with the codebase structure (see section 2.8.2)
|
3. Familiarize yourself with the codebase structure (see section 2.8.2)
|
||||||
|
|
||||||
### 4.2 Development Setup
|
### 4.2. Development Setup
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Clone your fork locally
|
2. Clone your fork locally
|
||||||
@@ -336,25 +336,25 @@ Before contributing, please:
|
|||||||
7. Build the project: `pnpm run build`
|
7. Build the project: `pnpm run build`
|
||||||
8. Test your changes with a local instance
|
8. Test your changes with a local instance
|
||||||
|
|
||||||
### 4.3 Code Standards
|
### 4.3. Code Standards
|
||||||
|
|
||||||
The project enforces the following standards:
|
The project enforces the following standards:
|
||||||
|
|
||||||
- **TypeScript**: All code must be written in TypeScript
|
- **TypeScript**: All code must be written in TypeScript
|
||||||
- **ESLint**: Code must pass linting with zero warnings (`@nhcarrigan/eslint-config`)
|
- **ESLint**: Code must pass linting with zero warnings (`@nhcarrigan/eslint-config`)
|
||||||
- **TypeScript Config**: Uses `@nhcarrigan/typescript-config`
|
- **TypeScript Config**: Uses `@nhcarrigan/typescript-config`
|
||||||
- **File Headers**: All files must include copyright header with license and author information
|
- **File Headers**: All files must include copyright header with licence and author information
|
||||||
|
|
||||||
Example header:
|
Example header:
|
||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright NHCarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.4 Module Guidelines
|
### 4.4. Module Guidelines
|
||||||
|
|
||||||
When creating or modifying modules:
|
When creating or modifying modules:
|
||||||
|
|
||||||
@@ -364,7 +364,7 @@ When creating or modifying modules:
|
|||||||
4. **Documentation**: Include JSDoc comments for all exported functions
|
4. **Documentation**: Include JSDoc comments for all exported functions
|
||||||
5. **Testing**: Consider how your changes can be tested (when tests are implemented)
|
5. **Testing**: Consider how your changes can be tested (when tests are implemented)
|
||||||
|
|
||||||
### 4.5 Adding New Features
|
### 4.5. Adding New Features
|
||||||
|
|
||||||
When adding new features:
|
When adding new features:
|
||||||
|
|
||||||
@@ -375,7 +375,7 @@ When adding new features:
|
|||||||
5. **Server Routes**: Add new endpoints in `src/server/serve.ts` if needed
|
5. **Server Routes**: Add new endpoints in `src/server/serve.ts` if needed
|
||||||
6. **Documentation**: Update this documentation file to reflect new features
|
6. **Documentation**: Update this documentation file to reflect new features
|
||||||
|
|
||||||
### 4.6 Submitting Changes
|
### 4.6. Submitting Changes
|
||||||
|
|
||||||
1. Commit your changes with descriptive commit messages
|
1. Commit your changes with descriptive commit messages
|
||||||
2. Push to your fork
|
2. Push to your fork
|
||||||
@@ -384,7 +384,7 @@ When adding new features:
|
|||||||
5. Address any review feedback
|
5. Address any review feedback
|
||||||
6. Once approved, your changes will be merged
|
6. Once approved, your changes will be merged
|
||||||
|
|
||||||
### 4.7 Key Files for Contributors
|
### 4.7. Key Files for Contributors
|
||||||
|
|
||||||
- `src/index.ts`: Main application entry point
|
- `src/index.ts`: Main application entry point
|
||||||
- `src/config/ids.ts`: Discord server IDs configuration
|
- `src/config/ids.ts`: Discord server IDs configuration
|
||||||
@@ -393,7 +393,7 @@ When adding new features:
|
|||||||
- `src/modules/`: Individual feature implementations
|
- `src/modules/`: Individual feature implementations
|
||||||
- `package.json`: Dependencies and scripts
|
- `package.json`: Dependencies and scripts
|
||||||
|
|
||||||
### 4.8 Common Tasks
|
### 4.8. Common Tasks
|
||||||
|
|
||||||
#### Adding a New Form Type
|
#### Adding a New Form Type
|
||||||
|
|
||||||
@@ -418,15 +418,15 @@ When adding new features:
|
|||||||
2. Define interfaces for payloads in `src/interfaces/`
|
2. Define interfaces for payloads in `src/interfaces/`
|
||||||
3. Ensure proper authentication checking with secrets
|
3. Ensure proper authentication checking with secrets
|
||||||
|
|
||||||
### 4.9 Support and Questions
|
### 4.9. Support and Questions
|
||||||
|
|
||||||
If you have questions about contributing:
|
If you have questions about contributing:
|
||||||
|
|
||||||
- Open a GitHub issue for bugs or feature requests
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Join the Discord server at https://chat.nhcarrigan.com for discussions
|
- Join the Discord server at https://chat.nhcarrigan.com for discussions
|
||||||
- Email contact@nhcarrigan.com for private inquiries
|
- Email contact@nhcarrigan.com for private inquiries
|
||||||
|
|
||||||
### 4.10 Analytics and Logging
|
### 4.10. Analytics and Logging
|
||||||
|
|
||||||
The Application uses custom logging and analytics:
|
The Application uses custom logging and analytics:
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
To use Aria Iuvo, [add the bot to your Discord account](https://discord.com/oauth2/authorize?client_id=1338596130207957035) using the provided authorization link. The bot operates as a user-installable application, meaning it can be used across any Discord server or direct message where you have access.
|
To use Aria Iuvo, [add the bot to your Discord account](https://discord.com/oauth2/authorise?client_id=1338596130207957035) using the provided authorisation link. The bot operates as a user-installable application, meaning it can be used across any Discord server or direct message where you have access.
|
||||||
|
|
||||||
### Core Features
|
### Core Features
|
||||||
|
|
||||||
@@ -172,7 +172,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### Licensing
|
### Licensing
|
||||||
|
|
||||||
Aria Iuvo is licensed under Naomi's Public License, as referenced in the global software license documentation available at [docs.nhcarrigan.com](https://docs.nhcarrigan.com/#/license).
|
Aria Iuvo is licensed under Naomi's Public Licence, as referenced in the global software licence documentation available at [docs.nhcarrigan.com](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
### Data Handling
|
### Data Handling
|
||||||
|
|
||||||
@@ -192,8 +192,8 @@ Aria Iuvo is licensed under Naomi's Public License, as referenced in the global
|
|||||||
|
|
||||||
### Copyright and Attribution
|
### Copyright and Attribution
|
||||||
|
|
||||||
- **Copyright Holder**: Naomi Carrigan (nhcarrigan)
|
- **Copyright Holder**: Naomi Carrigan (NHCarrigan)
|
||||||
- **Source Code**: Available at [git.nhcarrigan.com/nhcarrigan/aria-iuvo](https://git.nhcarrigan.com/nhcarrigan/aria-iuvo)
|
- **Source Code**: Available at [git.nhcarrigan.com/NHCarrigan/aria-iuvo](https://git.nhcarrigan.com/NHCarrigan/aria-iuvo)
|
||||||
- **Attribution**: Uses LibreTranslate for translation services
|
- **Attribution**: Uses LibreTranslate for translation services
|
||||||
|
|
||||||
## 4. Contributing Documentation
|
## 4. Contributing Documentation
|
||||||
@@ -283,7 +283,7 @@ npx vitest run --coverage
|
|||||||
### Bug Reports and Feature Requests
|
### Bug Reports and Feature Requests
|
||||||
|
|
||||||
#### Issue Templates
|
#### Issue Templates
|
||||||
- **Bug Reports**: Include steps to reproduce, expected vs actual behavior
|
- **Bug Reports**: Include steps to reproduce, expected vs actual behaviour
|
||||||
- **Feature Requests**: Describe use case, proposed implementation
|
- **Feature Requests**: Describe use case, proposed implementation
|
||||||
- **Translation Issues**: Specify locale and incorrect translation
|
- **Translation Issues**: Specify locale and incorrect translation
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Becca Lyria
|
title: Becca Lyria
|
||||||
---
|
---
|
||||||
|
|
||||||
Becca Lyria (hereinafter the "Application") is an AI-powered Discord bot that provides an interactive text-based role-playing game experience through direct messages. The bot utilizes Anthropic's Claude AI to create dynamic, personalized RPG adventures for users.
|
Becca Lyria (hereinafter the "Application") is an AI-powered Discord bot that provides an interactive text-based role-playing game experience through direct messages. The bot utilizes Anthropic's Claude AI to create dynamic, personalised RPG adventures for users.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -14,7 +14,7 @@ Becca Lyria is a user-installable Discord bot that transforms your DMs into an i
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
1. **Installation**: [Add Becca Lyria to your Discord account](https://discord.com/oauth2/authorize?client_id=1343341112437248041)
|
1. **Installation**: [Add Becca Lyria to your Discord account](https://discord.com/oauth2/authorise?client_id=1343341112437248041)
|
||||||
2. **Subscription**: The bot requires an active subscription to use its features
|
2. **Subscription**: The bot requires an active subscription to use its features
|
||||||
3. **Start Playing**: Use the `/start` command to begin your adventure
|
3. **Start Playing**: Use the `/start` command to begin your adventure
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ Becca Lyria is built as a modern Discord bot using TypeScript and several key te
|
|||||||
**AI Integration:**
|
**AI Integration:**
|
||||||
- **Provider**: Anthropic Claude (claude-3-5-sonnet-latest for conversations, claude-sonnet-4-20250514 for story starts)
|
- **Provider**: Anthropic Claude (claude-3-5-sonnet-latest for conversations, claude-sonnet-4-20250514 for story starts)
|
||||||
- **Context Management**: Maintains up to 20 messages of conversation history
|
- **Context Management**: Maintains up to 20 messages of conversation history
|
||||||
- **Personality System**: Configurable personality traits for consistent character behavior
|
- **Personality System**: Configurable personality traits for consistent character behaviour
|
||||||
|
|
||||||
### Project Structure
|
### Project Structure
|
||||||
|
|
||||||
@@ -137,7 +137,7 @@ The application requires several environment variables:
|
|||||||
- Web server runs on port 5010 for health checks
|
- Web server runs on port 5010 for health checks
|
||||||
- Requires Discord bot permissions for DMs and message content
|
- Requires Discord bot permissions for DMs and message content
|
||||||
- Needs stable Anthropic API access
|
- Needs stable Anthropic API access
|
||||||
- Logging integration with nhcarrigan logging service
|
- Logging integration with NHCarrigan logging service
|
||||||
|
|
||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
@@ -178,13 +178,13 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
- Currently no tests implemented (placeholder exists)
|
- Currently no tests implemented (placeholder exists)
|
||||||
|
|
||||||
**Licensing:**
|
**Licensing:**
|
||||||
- Licensed under Naomi's Public License
|
- Licensed under Naomi's Public Licence
|
||||||
- Copyright held by Naomi Carrigan
|
- Copyright held by Naomi Carrigan
|
||||||
- See LICENSE.md for full terms
|
- See LICENSE.md for full terms
|
||||||
|
|
||||||
### Contribution Process
|
### Contribution Process
|
||||||
|
|
||||||
1. **Issues**: Report bugs and request features through GitHub issues
|
1. **Issues**: Report bugs in the #bug-reports forum channel and feature requests in the #feature-requests forum channel on our Discord community
|
||||||
2. **Pull Requests**: Fork, develop, and submit PRs for review
|
2. **Pull Requests**: Fork, develop, and submit PRs for review
|
||||||
3. **Code Review**: All changes require review before merging
|
3. **Code Review**: All changes require review before merging
|
||||||
4. **Guidelines**: Follow established [contributing guidelines](CONTRIBUTING.md)
|
4. **Guidelines**: Follow established [contributing guidelines](CONTRIBUTING.md)
|
||||||
@@ -206,7 +206,7 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
|
|
||||||
### Contact Information
|
### Contact Information
|
||||||
|
|
||||||
- **Chat Server**: [http://chat.nhcarrigan.com](http://chat.nhcarrigan.com)
|
- **Chat Server**: [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
- **Source Code**: [https://git.nhcarrigan.com/nhcarrigan/becca-lyria](https://git.nhcarrigan.com/nhcarrigan/becca-lyria)
|
- **Source Code**: [https://git.nhcarrigan.com/nhcarrigan/becca-lyria](https://git.nhcarrigan.com/NHCarrigan/becca-lyria)
|
||||||
- **Documentation**: [https://docs.nhcarrigan.com/](https://docs.nhcarrigan.com/)
|
- **Documentation**: [https://docs.nhcarrigan.com/](https://docs.nhcarrigan.com/)
|
||||||
|
|||||||
@@ -83,15 +83,15 @@ posts/ # Markdown blog posts
|
|||||||
- **SEO Optimized**: Proper metadata, Open Graph, and Twitter Card support
|
- **SEO Optimized**: Proper metadata, Open Graph, and Twitter Card support
|
||||||
- **TypeScript**: Full type safety throughout the application
|
- **TypeScript**: Full type safety throughout the application
|
||||||
- **Responsive Design**: Mobile-friendly layout
|
- **Responsive Design**: Mobile-friendly layout
|
||||||
- **Custom Styling**: Branded colors and typography
|
- **Custom Styling**: Branded colours and typography
|
||||||
|
|
||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
### License
|
### License
|
||||||
The Application is distributed under **Naomi's Public License** as indicated in the source code headers.
|
The Application is distributed under **Naomi's Public Licence** as indicated in the source code headers.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
All source code is copyright © nhcarrigan (Naomi Carrigan).
|
All source code is copyright © NHCarrigan (Naomi Carrigan).
|
||||||
|
|
||||||
### Third-Party Dependencies
|
### Third-Party Dependencies
|
||||||
The Application uses the following open-source libraries:
|
The Application uses the following open-source libraries:
|
||||||
@@ -131,8 +131,8 @@ Blog post content represents the personal opinions and experiences of the author
|
|||||||
All source files must include the standard copyright header:
|
All source files must include the standard copyright header:
|
||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright nhcarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Boost Monitor
|
title: Boost Monitor
|
||||||
---
|
---
|
||||||
|
|
||||||
Boost Monitor (hereinafter the "Application") is a Discord bot that automatically manages special roles for server boosters. The Application monitors server members and removes booster-exclusive roles (such as custom color roles) when a member stops boosting the server.
|
Boost Monitor (hereinafter the "Application") is a Discord bot that automatically manages special roles for server boosters. The Application monitors server members and removes booster-exclusive roles (such as custom colour roles) when a member stops boosting the server.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -16,12 +16,12 @@ The Discord Boost Monitor operates automatically in the background of your Disco
|
|||||||
|
|
||||||
1. **Automatic Monitoring**: The bot monitors all member updates in the Discord server
|
1. **Automatic Monitoring**: The bot monitors all member updates in the Discord server
|
||||||
2. **Boost Detection**: When a member's boost status changes, the bot checks if they still have the server booster role
|
2. **Boost Detection**: When a member's boost status changes, the bot checks if they still have the server booster role
|
||||||
3. **Role Management**: If a member no longer has the booster role, the bot automatically removes any configured booster-exclusive roles (such as custom color roles)
|
3. **Role Management**: If a member no longer has the booster role, the bot automatically removes any configured booster-exclusive roles (such as custom colour roles)
|
||||||
|
|
||||||
### Key Features
|
### Key Features
|
||||||
|
|
||||||
- **Automated Role Removal**: No manual intervention needed when members stop boosting
|
- **Automated Role Removal**: No manual intervention needed when members stop boosting
|
||||||
- **Configurable Roles**: Server-specific booster and color role IDs can be configured
|
- **Configurable Roles**: Server-specific booster and colour role IDs can be configured
|
||||||
- **Status Monitoring**: Health check endpoint available at the bot's web interface
|
- **Status Monitoring**: Health check endpoint available at the bot's web interface
|
||||||
- **Debug Webhooks**: Sends status updates and error reports to configured Discord webhooks
|
- **Debug Webhooks**: Sends status updates and error reports to configured Discord webhooks
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/nhcarrigan/oogie-woogie-boostie-woostie.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/boost-monitor.git
|
||||||
cd oogie-woogie-boostie-woostie
|
cd oogie-woogie-boostie-woostie
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ Example:
|
|||||||
export const colourRoles = [
|
export const colourRoles = [
|
||||||
"883281643098484736", // Red role
|
"883281643098484736", // Red role
|
||||||
"883283836887261204", // Blue role
|
"883283836887261204", // Blue role
|
||||||
// Add your color role IDs here
|
// Add your colour role IDs here
|
||||||
];
|
];
|
||||||
|
|
||||||
export const boosterRole = "712431541531181177"; // Your booster role ID
|
export const boosterRole = "712431541531181177"; // Your booster role ID
|
||||||
@@ -122,8 +122,8 @@ Update the paths in `src/server/serve.ts:18-22` if your certificates are located
|
|||||||
- **Main Entry Point** (`src/index.ts`): Initializes the Discord client, sets up event listeners, and starts the web server
|
- **Main Entry Point** (`src/index.ts`): Initializes the Discord client, sets up event listeners, and starts the web server
|
||||||
- **Role Manager** (`src/modules/manageRoles.ts`): Core logic for detecting boost status and removing roles
|
- **Role Manager** (`src/modules/manageRoles.ts`): Core logic for detecting boost status and removing roles
|
||||||
- **Web Server** (`src/server/serve.ts`): Fastify-based HTTPS server for health monitoring
|
- **Web Server** (`src/server/serve.ts`): Fastify-based HTTPS server for health monitoring
|
||||||
- **Error Handler** (`src/utils/errorHandler.ts`): Centralized error handling with Sentry integration and Discord webhook notifications
|
- **Error Handler** (`src/utils/errorHandler.ts`): Centralised error handling with Sentry integration and Discord webhook notifications
|
||||||
- **Log Handler** (`src/utils/logHandler.ts`): Winston-based logging with timestamps and color coding
|
- **Log Handler** (`src/utils/logHandler.ts`): Winston-based logging with timestamps and colour coding
|
||||||
|
|
||||||
#### Bot Intents
|
#### Bot Intents
|
||||||
|
|
||||||
@@ -138,7 +138,7 @@ Note: The `GuildMembers` intent must be enabled in your bot's Discord Developer
|
|||||||
1. Bot connects to Discord and fetches guild members (src/index.ts:25-39)
|
1. Bot connects to Discord and fetches guild members (src/index.ts:25-39)
|
||||||
2. Bot listens for `guildMemberUpdate` events (src/index.ts:42-44)
|
2. Bot listens for `guildMemberUpdate` events (src/index.ts:42-44)
|
||||||
3. On member update, `manageRoles` function checks boost status (src/modules/manageRoles.ts:13-26)
|
3. On member update, `manageRoles` function checks boost status (src/modules/manageRoles.ts:13-26)
|
||||||
4. If member is not boosting, configured color roles are removed
|
4. If member is not boosting, configured colour roles are removed
|
||||||
5. Errors are logged and sent to Sentry and debug webhook
|
5. Errors are logged and sent to Sentry and debug webhook
|
||||||
|
|
||||||
#### Web Server
|
#### Web Server
|
||||||
@@ -169,7 +169,7 @@ Debug webhooks are used for:
|
|||||||
|
|
||||||
Winston logger provides console output with:
|
Winston logger provides console output with:
|
||||||
- Timestamps in `YYYY-MM-DD HH:mm:ss` format
|
- Timestamps in `YYYY-MM-DD HH:mm:ss` format
|
||||||
- Color-coded log levels
|
- Colour-coded log levels
|
||||||
- NPM-style log levels (silly, verbose, info, warn, error)
|
- NPM-style log levels (silly, verbose, info, warn, error)
|
||||||
|
|
||||||
### Deployment Considerations
|
### Deployment Considerations
|
||||||
@@ -187,7 +187,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### Software License
|
### Software License
|
||||||
|
|
||||||
This Application is licensed under the global software license maintained by Naomi Carrigan. Full license details can be found at: https://docs.nhcarrigan.com/#/license
|
This Application is licensed under the global software licence maintained by Naomi Carrigan. Full licence details can be found at: https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ src/
|
|||||||
├── server/
|
├── server/
|
||||||
│ └── serve.ts # Fastify web server
|
│ └── serve.ts # Fastify web server
|
||||||
└── utils/
|
└── utils/
|
||||||
├── errorHandler.ts # Centralized error handling
|
├── errorHandler.ts # Centralised error handling
|
||||||
└── logHandler.ts # Winston logging configuration
|
└── logHandler.ts # Winston logging configuration
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -284,10 +284,10 @@ All contributors must adhere to the Code of Conduct outlined in: CODE_OF_CONDUCT
|
|||||||
|
|
||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
|
|
||||||
Bug reports and feature requests can be submitted at: https://github.com/nhcarrigan/oogie-woogie-boostie-woostie/issues
|
Bug reports and feature requests should be posted in the #bug-reports or #feature-requests forum channels on our Discord community.
|
||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
|
|
||||||
For questions or support:
|
For questions or support:
|
||||||
- **Chat Server**: http://chat.nhcarrigan.com
|
- **Chat Server**: https://chat.nhcarrigan.com
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Caelia
|
title: Caelia
|
||||||
---
|
---
|
||||||
|
|
||||||
Caelia (hereinafter the "Application") is a Discord bot that provides gentle reminders when users utilize non-inclusive language in their messages, helping promote more welcoming and inclusive community spaces.
|
Caelia (hereinafter the "Application") is a Discord bot that provides gentle reminders when users utilise non-inclusive language in their messages, helping promote more welcoming and inclusive community spaces.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -14,7 +14,7 @@ Caelia is a Discord bot designed to help create more inclusive communities by ge
|
|||||||
|
|
||||||
### How to Add Caelia to Your Server
|
### How to Add Caelia to Your Server
|
||||||
|
|
||||||
1. Visit the authorization link: https://discord.com/oauth2/authorize?client_id=1408530011572535346
|
1. Visit the authorisation link: https://discord.com/oauth2/authorise?client_id=1408530011572535346
|
||||||
2. Select your server and grant the necessary permissions
|
2. Select your server and grant the necessary permissions
|
||||||
3. Caelia will automatically begin monitoring messages in channels where she has access
|
3. Caelia will automatically begin monitoring messages in channels where she has access
|
||||||
|
|
||||||
@@ -129,7 +129,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. All code is copyright NHCarrigan and authored by Naomi Carrigan.
|
This software is licensed under Naomi's Public Licence. All code is copyright NHCarrigan and authored by Naomi Carrigan.
|
||||||
|
|
||||||
### Data Handling
|
### Data Handling
|
||||||
|
|
||||||
@@ -205,7 +205,7 @@ src/
|
|||||||
|
|
||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
|
|
||||||
- Use GitHub issues for bug reports
|
- Post in the #bug-reports forum channel on our Discord community for bug reports
|
||||||
- Join the Discord support server for discussions: https://chat.nhcarrigan.com
|
- Join the Discord support server for discussions: https://chat.nhcarrigan.com
|
||||||
- Email support: contact@nhcarrigan.com
|
- Email support: contact@nhcarrigan.com
|
||||||
|
|
||||||
|
|||||||
@@ -2,18 +2,18 @@
|
|||||||
title: Callista
|
title: Callista
|
||||||
---
|
---
|
||||||
|
|
||||||
Callista (hereinafter the "Application") is a Discord bot that allows users to bookmark messages so they can find them later. The Application provides a simple interface for saving message links via DM, with optional note-taking capabilities to help organize and remember why messages were bookmarked.
|
Callista (hereinafter the "Application") is a Discord bot that allows users to bookmark messages so they can find them later. The Application provides a simple interface for saving message links via DM, with optional note-taking capabilities to help organise and remember why messages were bookmarked.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Adding the Bot
|
### 1.1. Adding the Bot
|
||||||
|
|
||||||
Callista is available as a Discord user-installable application. You can add Callista to your Discord account by visiting:
|
Callista is available as a Discord user-installable application. You can add Callista to your Discord account by visiting:
|
||||||
https://discord.com/oauth2/authorize?client_id=1391494389477412906
|
https://discord.com/oauth2/authorise?client_id=1391494389477412906
|
||||||
|
|
||||||
### 1.2 Bookmarking Messages
|
### 1.2. Bookmarking Messages
|
||||||
|
|
||||||
To bookmark a message:
|
To bookmark a message:
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ To bookmark a message:
|
|||||||
|
|
||||||
**Note:** You must have Direct Messages enabled to receive bookmarks. If you receive an error, check your Discord privacy settings.
|
**Note:** You must have Direct Messages enabled to receive bookmarks. If you receive an error, check your Discord privacy settings.
|
||||||
|
|
||||||
### 1.3 Adding Notes to Bookmarks
|
### 1.3. Adding Notes to Bookmarks
|
||||||
|
|
||||||
Each bookmark can have an associated note to help you remember context:
|
Each bookmark can have an associated note to help you remember context:
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ Each bookmark can have an associated note to help you remember context:
|
|||||||
3. Enter your note (1-1000 characters)
|
3. Enter your note (1-1000 characters)
|
||||||
4. Your note will be appended to the bookmark message
|
4. Your note will be appended to the bookmark message
|
||||||
|
|
||||||
### 1.4 Editing Notes
|
### 1.4. Editing Notes
|
||||||
|
|
||||||
To edit an existing note on a bookmark:
|
To edit an existing note on a bookmark:
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ To edit an existing note on a bookmark:
|
|||||||
2. Update the note text in the modal
|
2. Update the note text in the modal
|
||||||
3. The bookmark message will be updated with your new note
|
3. The bookmark message will be updated with your new note
|
||||||
|
|
||||||
### 1.5 Deleting Bookmarks
|
### 1.5. Deleting Bookmarks
|
||||||
|
|
||||||
To delete a bookmark from your DMs:
|
To delete a bookmark from your DMs:
|
||||||
|
|
||||||
@@ -50,14 +50,14 @@ To delete a bookmark from your DMs:
|
|||||||
|
|
||||||
**Note:** The Delete command only works in DMs with Callista (bot DM context).
|
**Note:** The Delete command only works in DMs with Callista (bot DM context).
|
||||||
|
|
||||||
### 1.6 Additional Features
|
### 1.6. Additional Features
|
||||||
|
|
||||||
Each bookmark message includes convenient buttons:
|
Each bookmark message includes convenient buttons:
|
||||||
- **Add Note/Edit Note**: Add or modify notes on your bookmarks
|
- **Add Note/Edit Note**: Add or modify notes on your bookmarks
|
||||||
- **Join our Discord**: Link to the support server (https://chat.nhcarrigan.com)
|
- **Join our Discord**: Link to the support server (https://chat.nhcarrigan.com)
|
||||||
- **Donate**: Premium button for supporting the bot developer
|
- **Donate**: Premium button for supporting the bot developer
|
||||||
|
|
||||||
### 1.7 Command Reference
|
### 1.7. Command Reference
|
||||||
|
|
||||||
| Command | Type | Context | Description |
|
| Command | Type | Context | Description |
|
||||||
|---------|------|---------|-------------|
|
|---------|------|---------|-------------|
|
||||||
@@ -68,14 +68,14 @@ Each bookmark message includes convenient buttons:
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Prerequisites
|
### 2.1. Prerequisites
|
||||||
|
|
||||||
- Node.js (compatible with version specified in package.json)
|
- Node.js (compatible with version specified in package.json)
|
||||||
- pnpm 10.17.1 or higher (specified in packageManager field)
|
- pnpm 10.17.1 or higher (specified in packageManager field)
|
||||||
- A Discord Bot Token
|
- A Discord Bot Token
|
||||||
- 1Password CLI (op) for production environment variables (or modify start script)
|
- 1Password CLI (op) for production environment variables (or modify start script)
|
||||||
|
|
||||||
### 2.2 Dependencies
|
### 2.2. Dependencies
|
||||||
|
|
||||||
**Runtime Dependencies:**
|
**Runtime Dependencies:**
|
||||||
- `discord.js` (14.22.1): Discord API wrapper
|
- `discord.js` (14.22.1): Discord API wrapper
|
||||||
@@ -87,7 +87,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
- ESLint with @nhcarrigan configuration
|
- ESLint with @nhcarrigan configuration
|
||||||
- tsx for development execution
|
- tsx for development execution
|
||||||
|
|
||||||
### 2.3 Installation
|
### 2.3. Installation
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
@@ -111,7 +111,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
```
|
```
|
||||||
Copy the output JSON and register it via the Discord Developer Portal or API.
|
Copy the output JSON and register it via the Discord Developer Portal or API.
|
||||||
|
|
||||||
### 2.4 Building
|
### 2.4. Building
|
||||||
|
|
||||||
Compile TypeScript to JavaScript:
|
Compile TypeScript to JavaScript:
|
||||||
```bash
|
```bash
|
||||||
@@ -120,7 +120,7 @@ pnpm run build
|
|||||||
|
|
||||||
Output is generated in the `prod/` directory.
|
Output is generated in the `prod/` directory.
|
||||||
|
|
||||||
### 2.5 Running
|
### 2.5. Running
|
||||||
|
|
||||||
**Production:**
|
**Production:**
|
||||||
```bash
|
```bash
|
||||||
@@ -134,7 +134,7 @@ This uses 1Password CLI to inject environment variables. Modify the start script
|
|||||||
tsx src/index.ts
|
tsx src/index.ts
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.6 Architecture Overview
|
### 2.6. Architecture Overview
|
||||||
|
|
||||||
**Project Structure:**
|
**Project Structure:**
|
||||||
```
|
```
|
||||||
@@ -163,7 +163,7 @@ src/
|
|||||||
3. **Web Server** (`server/serve.ts:54-79`): Runs on port 6111 for health monitoring
|
3. **Web Server** (`server/serve.ts:54-79`): Runs on port 6111 for health monitoring
|
||||||
4. **Message Context Commands**: Registered via `commandData.js` with user-install integration
|
4. **Message Context Commands**: Registered via `commandData.js` with user-install integration
|
||||||
|
|
||||||
### 2.7 Bot Configuration
|
### 2.7. Bot Configuration
|
||||||
|
|
||||||
The bot requires the following Discord application settings:
|
The bot requires the following Discord application settings:
|
||||||
|
|
||||||
@@ -194,20 +194,20 @@ The bot requires the following Discord application settings:
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.8 Environment Variables
|
### 2.8. Environment Variables
|
||||||
|
|
||||||
| Variable | Required | Description |
|
| Variable | Required | Description |
|
||||||
|----------|----------|-------------|
|
|----------|----------|-------------|
|
||||||
| BOT_TOKEN | Yes | Discord bot token for authentication |
|
| BOT_TOKEN | Yes | Discord bot token for authentication |
|
||||||
|
|
||||||
### 2.9 Monitoring and Health Checks
|
### 2.9. Monitoring and Health Checks
|
||||||
|
|
||||||
The Application exposes a web server on port 6111:
|
The Application exposes a web server on port 6111:
|
||||||
- **Endpoint:** `GET /`
|
- **Endpoint:** `GET /`
|
||||||
- **Response:** HTML page with bot information
|
- **Response:** HTML page with bot information
|
||||||
- **Purpose:** Health monitoring and bot information display
|
- **Purpose:** Health monitoring and bot information display
|
||||||
|
|
||||||
### 2.10 Logging
|
### 2.10. Logging
|
||||||
|
|
||||||
Logging is handled via `@nhcarrigan/logger` with the following log levels:
|
Logging is handled via `@nhcarrigan/logger` with the following log levels:
|
||||||
- `debug`: Informational messages (bot online, server started)
|
- `debug`: Informational messages (bot online, server started)
|
||||||
@@ -215,14 +215,14 @@ Logging is handled via `@nhcarrigan/logger` with the following log levels:
|
|||||||
|
|
||||||
Logs are written from `utils/logger.ts:1`.
|
Logs are written from `utils/logger.ts:1`.
|
||||||
|
|
||||||
### 2.11 Error Handling
|
### 2.11. Error Handling
|
||||||
|
|
||||||
The Application implements error handling for:
|
The Application implements error handling for:
|
||||||
- Failed DM delivery (user has DMs disabled) - `interactions/bookmark.ts:43-46`
|
- Failed DM delivery (user has DMs disabled) - `interactions/bookmark.ts:43-46`
|
||||||
- Missing message context for modals - `index.ts:46-52`
|
- Missing message context for modals - `index.ts:46-52`
|
||||||
- Server startup failures - `server/serve.ts:66-77`
|
- Server startup failures - `server/serve.ts:66-77`
|
||||||
|
|
||||||
### 2.12 Deployment Considerations
|
### 2.12. Deployment Considerations
|
||||||
|
|
||||||
1. **Port Configuration:** The web server runs on port 6111 by default
|
1. **Port Configuration:** The web server runs on port 6111 by default
|
||||||
2. **Secrets Management:** The default start script uses 1Password CLI
|
2. **Secrets Management:** The default start script uses 1Password CLI
|
||||||
@@ -233,15 +233,15 @@ The Application implements error handling for:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
This Application is licensed under **Naomi's Public License** as indicated in the source file headers.
|
This Application is licensed under **Naomi's Public Licence** as indicated in the source file headers.
|
||||||
|
|
||||||
Copyright held by **NHCarrigan / Naomi Carrigan**.
|
Copyright held by **NHCarrigan / Naomi Carrigan**.
|
||||||
|
|
||||||
Full license text available at: https://docs.nhcarrigan.com/#/license
|
Full licence text available at: https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
### 3.2 Privacy
|
### 3.2. Privacy
|
||||||
|
|
||||||
Privacy policy document: `PRIVACY.md` in the repository root.
|
Privacy policy document: `PRIVACY.md` in the repository root.
|
||||||
|
|
||||||
@@ -254,17 +254,17 @@ Privacy policy document: `PRIVACY.md` in the repository root.
|
|||||||
|
|
||||||
**Data Retention:** Data persists as long as users keep their DM messages. Users can delete bookmarks at any time using the Delete command.
|
**Data Retention:** Data persists as long as users keep their DM messages. Users can delete bookmarks at any time using the Delete command.
|
||||||
|
|
||||||
### 3.3 Terms of Service
|
### 3.3. Terms of Service
|
||||||
|
|
||||||
Terms of service document: `TERMS.md` in the repository root.
|
Terms of service document: `TERMS.md` in the repository root.
|
||||||
|
|
||||||
### 3.4 Security
|
### 3.4. Security
|
||||||
|
|
||||||
Security policy document: `SECURITY.md` in the repository root.
|
Security policy document: `SECURITY.md` in the repository root.
|
||||||
|
|
||||||
For security concerns, please follow the reporting procedures outlined in the security policy.
|
For security concerns, please follow the reporting procedures outlined in the security policy.
|
||||||
|
|
||||||
### 3.5 Code of Conduct
|
### 3.5. Code of Conduct
|
||||||
|
|
||||||
Code of conduct document: `CODE_OF_CONDUCT.md` in the repository root.
|
Code of conduct document: `CODE_OF_CONDUCT.md` in the repository root.
|
||||||
|
|
||||||
@@ -272,7 +272,7 @@ Code of conduct document: `CODE_OF_CONDUCT.md` in the repository root.
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Contributing guidelines document: `CONTRIBUTING.md` in the repository root.
|
Contributing guidelines document: `CONTRIBUTING.md` in the repository root.
|
||||||
|
|
||||||
@@ -281,7 +281,7 @@ Before contributing, please review:
|
|||||||
2. The Contributing Guidelines (`CONTRIBUTING.md`)
|
2. The Contributing Guidelines (`CONTRIBUTING.md`)
|
||||||
3. The License terms (`LICENSE.md`)
|
3. The License terms (`LICENSE.md`)
|
||||||
|
|
||||||
### 4.2 Development Setup
|
### 4.2. Development Setup
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Clone your fork
|
2. Clone your fork
|
||||||
@@ -290,7 +290,7 @@ Before contributing, please review:
|
|||||||
5. Copy your bot token to a `prod.env` file (or use environment variables directly)
|
5. Copy your bot token to a `prod.env` file (or use environment variables directly)
|
||||||
6. Run the development server: `tsx src/index.ts`
|
6. Run the development server: `tsx src/index.ts`
|
||||||
|
|
||||||
### 4.3 Code Standards
|
### 4.3. Code Standards
|
||||||
|
|
||||||
The project uses:
|
The project uses:
|
||||||
- **TypeScript** (5.9.2) with strict type checking
|
- **TypeScript** (5.9.2) with strict type checking
|
||||||
@@ -304,13 +304,13 @@ pnpm run lint
|
|||||||
|
|
||||||
**Note:** The lint script uses `--max-warnings 0`, so warnings are treated as errors.
|
**Note:** The lint script uses `--max-warnings 0`, so warnings are treated as errors.
|
||||||
|
|
||||||
### 4.4 Code Style Notes
|
### 4.4. Code Style Notes
|
||||||
|
|
||||||
- All source files include copyright headers with `@copyright`, `@license`, and `@author` tags
|
- All source files include copyright headers with `@copyright`, `@license`, and `@author` tags
|
||||||
- Some ESLint rules are selectively disabled with comments (e.g., `index.ts:26`)
|
- Some ESLint rules are selectively disabled with comments (e.g., `index.ts:26`)
|
||||||
- The project uses ESM (module) syntax (`"type": "module"` in package.json)
|
- The project uses ESM (module) syntax (`"type": "module"` in package.json)
|
||||||
|
|
||||||
### 4.5 Testing
|
### 4.5. Testing
|
||||||
|
|
||||||
Currently, the project has a placeholder test script:
|
Currently, the project has a placeholder test script:
|
||||||
```bash
|
```bash
|
||||||
@@ -319,7 +319,7 @@ pnpm test
|
|||||||
|
|
||||||
This exits with code 0 (no tests configured yet).
|
This exits with code 0 (no tests configured yet).
|
||||||
|
|
||||||
### 4.6 Pull Request Process
|
### 4.6. Pull Request Process
|
||||||
|
|
||||||
1. Create a feature branch from `main`
|
1. Create a feature branch from `main`
|
||||||
2. Make your changes following the code standards
|
2. Make your changes following the code standards
|
||||||
@@ -328,12 +328,12 @@ This exits with code 0 (no tests configured yet).
|
|||||||
5. Submit a pull request with a clear description of changes
|
5. Submit a pull request with a clear description of changes
|
||||||
6. Address any review feedback
|
6. Address any review feedback
|
||||||
|
|
||||||
### 4.7 Adding New Features
|
### 4.7. Adding New Features
|
||||||
|
|
||||||
**Adding a new button:**
|
**Adding a new button:**
|
||||||
1. Create a new file in `src/buttons/` exporting a `ButtonBuilder`
|
1. Create a new file in `src/buttons/` exporting a `ButtonBuilder`
|
||||||
2. Import and add the button to the relevant `ActionRowBuilder` in `index.ts`
|
2. Import and add the button to the relevant `ActionRowBuilder` in `index.ts`
|
||||||
3. Add handler logic in `handleInteraction` if the button requires custom behavior
|
3. Add handler logic in `handleInteraction` if the button requires custom behaviour
|
||||||
|
|
||||||
**Adding a new command:**
|
**Adding a new command:**
|
||||||
1. Create a handler in `src/interactions/`
|
1. Create a handler in `src/interactions/`
|
||||||
@@ -346,28 +346,27 @@ This exits with code 0 (no tests configured yet).
|
|||||||
2. Add modal handling logic in the `isModalSubmit` section of `handleInteraction`
|
2. Add modal handling logic in the `isModalSubmit` section of `handleInteraction`
|
||||||
3. Link the modal to a button or command that calls `showModal()`
|
3. Link the modal to a button or command that calls `showModal()`
|
||||||
|
|
||||||
### 4.8 Repository Information
|
### 4.8. Repository Information
|
||||||
|
|
||||||
- **Main Branch:** `main`
|
- **Main Branch:** `main`
|
||||||
- **Package Manager:** pnpm (lockfile version: 10.17.1)
|
- **Package Manager:** pnpm (lockfile version: 10.17.1)
|
||||||
- **CI/CD:** Configuration available in `.gitea/` directory
|
- **CI/CD:** Configuration available in `.gitea/` directory
|
||||||
- **Editor Configuration:** VSCode settings in `.vscode/`
|
- **Editor Configuration:** VSCode settings in `.vscode/`
|
||||||
|
|
||||||
### 4.9 Contact
|
### 4.9. Contact
|
||||||
|
|
||||||
For questions or support:
|
For questions or support:
|
||||||
- **Support Server:** https://chat.nhcarrigan.com
|
- **Support Server:** https://chat.nhcarrigan.com
|
||||||
- **Email:** contact@nhcarrigan.com
|
- **Email:** contact@nhcarrigan.com
|
||||||
- **Documentation:** https://docs.nhcarrigan.com/
|
- **Documentation:** https://docs.nhcarrigan.com/
|
||||||
- **Source Code:** https://git.nhcarrigan.com/nhcarrigan/callista
|
- **Source Code:** https://git.nhcarrigan.com/NHCarrigan/callista
|
||||||
|
|
||||||
### 4.10 Issue Reporting
|
### 4.10. Issue Reporting
|
||||||
|
|
||||||
Please report bugs and feature requests via GitHub/Gitea issues at:
|
Please report bugs in the #bug-reports forum channel and feature requests in the #feature-requests forum channel on our Discord community.
|
||||||
https://git.nhcarrigan.com/nhcarrigan/callista
|
|
||||||
|
|
||||||
Include:
|
Include:
|
||||||
- Clear description of the issue or feature
|
- Clear description of the issue or feature
|
||||||
- Steps to reproduce (for bugs)
|
- Steps to reproduce (for bugs)
|
||||||
- Expected vs actual behavior
|
- Expected vs actual behaviour
|
||||||
- Environment details (Discord client version, etc.)
|
- Environment details (Discord client version, etc.)
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ Celestine (hereinafter the "Application") is a comprehensive paid moderation bot
|
|||||||
#### User Experience Features
|
#### User Experience Features
|
||||||
- **`/rank`** - View personal level and XP in the server
|
- **`/rank`** - View personal level and XP in the server
|
||||||
- **`/leaderboard`** - Browse server level rankings with pagination
|
- **`/leaderboard`** - Browse server level rankings with pagination
|
||||||
- **`/profile`** - Customize profile appearance (avatar, colors, background)
|
- **`/profile`** - Customise profile appearance (avatar, colours, background)
|
||||||
- **`/role`** - Self-assign permitted roles
|
- **`/role`** - Self-assign permitted roles
|
||||||
- **`/birthday`** - Set birthday for automatic celebrations
|
- **`/birthday`** - Set birthday for automatic celebrations
|
||||||
- **`/level-role`** - Configure roles automatically assigned at specific levels
|
- **`/level-role`** - Configure roles automatically assigned at specific levels
|
||||||
@@ -55,8 +55,8 @@ Celestine (hereinafter the "Application") is a comprehensive paid moderation bot
|
|||||||
|
|
||||||
#### Leveling System
|
#### Leveling System
|
||||||
- Automatic XP gain from message activity with anti-spam cooldowns
|
- Automatic XP gain from message activity with anti-spam cooldowns
|
||||||
- Customizable level roles that auto-assign at specified levels
|
- Customisable level roles that auto-assign at specified levels
|
||||||
- Visual profile cards with customizable backgrounds and colors
|
- Visual profile cards with customisable backgrounds and colours
|
||||||
- Server leaderboards with pagination
|
- Server leaderboards with pagination
|
||||||
|
|
||||||
#### Security & Moderation
|
#### Security & Moderation
|
||||||
@@ -277,7 +277,7 @@ The Application processes and stores:
|
|||||||
- Modular command structure for maintainability
|
- Modular command structure for maintainability
|
||||||
- Event-driven architecture for real-time responses
|
- Event-driven architecture for real-time responses
|
||||||
- Database abstraction through Prisma ORM
|
- Database abstraction through Prisma ORM
|
||||||
- Configuration-driven behavior customization
|
- Configuration-driven behaviour customisation
|
||||||
|
|
||||||
### Extension Points
|
### Extension Points
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
1. **Add Chibika to Your Discord Server**: Use the [Discord OAuth2 authorization link](https://discord.com/oauth2/authorize?client_id=1396225647269122098) to add Chibika to your Discord server.
|
1. **Add Chibika to Your Discord Server**: Use the [Discord OAuth2 authorisation link](https://discord.com/oauth2/authorise?client_id=1396225647269122098) to add Chibika to your Discord server.
|
||||||
|
|
||||||
2. **Purchase Server Subscription**: To use Chibika's features, you must purchase a server subscription through Discord's built-in store system.
|
2. **Purchase Server Subscription**: To use Chibika's features, you must purchase a server subscription through Discord's built-in store system.
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ Displays information about Chibika, including:
|
|||||||
- What the bot does
|
- What the bot does
|
||||||
- How to get started with server subscriptions
|
- How to get started with server subscriptions
|
||||||
- Support and help resources
|
- Support and help resources
|
||||||
- Links to Discord server and forum for assistance
|
- Links to Discord server for assistance
|
||||||
|
|
||||||
#### `/ascii [category]`
|
#### `/ascii [category]`
|
||||||
Retrieves random ASCII art from the specified category:
|
Retrieves random ASCII art from the specified category:
|
||||||
@@ -44,7 +44,6 @@ Retrieves random emoji-based ASCII art from the emoji collection.
|
|||||||
|
|
||||||
If you encounter issues or need assistance:
|
If you encounter issues or need assistance:
|
||||||
- Join the [Discord support server](https://chat.nhcarrigan.com)
|
- Join the [Discord support server](https://chat.nhcarrigan.com)
|
||||||
- Visit the [support forum](https://forum.nhcarrigan.com)
|
|
||||||
- Contact via email: `contact@nhcarrigan.com`
|
- Contact via email: `contact@nhcarrigan.com`
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
@@ -134,7 +133,7 @@ src/
|
|||||||
|
|
||||||
#### ASCII Art Management
|
#### ASCII Art Management
|
||||||
- Structured data format with `text` and `author` fields (`src/interfaces/ascii.ts:7`)
|
- Structured data format with `text` and `author` fields (`src/interfaces/ascii.ts:7`)
|
||||||
- Category-based organization (anime, cats, emoji)
|
- Category-based organisation (anime, cats, emoji)
|
||||||
- Random selection utility (`src/utils/getRandomValue.ts`)
|
- Random selection utility (`src/utils/getRandomValue.ts`)
|
||||||
|
|
||||||
#### Web Server
|
#### Web Server
|
||||||
@@ -147,7 +146,7 @@ src/
|
|||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### Licensing
|
### Licensing
|
||||||
- Source code licensed under Naomi's Public License
|
- Source code licensed under Naomi's Public Licence
|
||||||
- Copyright held by Naomi Carrigan (@nhcarrigan)
|
- Copyright held by Naomi Carrigan (@nhcarrigan)
|
||||||
|
|
||||||
### Terms and Privacy
|
### Terms and Privacy
|
||||||
@@ -156,7 +155,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### Security
|
### Security
|
||||||
- Security guidelines and reporting procedures outlined in `SECURITY.md`
|
- Security guidelines and reporting procedures outlined in `SECURITY.md`
|
||||||
- Responsible disclosure encouraged through GitHub issues
|
- Responsible disclosure encouraged through the #bug-reports forum channel on our Discord community
|
||||||
|
|
||||||
## 4. Contributing Documentation
|
## 4. Contributing Documentation
|
||||||
|
|
||||||
@@ -181,7 +180,7 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
6. Submit pull request
|
6. Submit pull request
|
||||||
|
|
||||||
### Issue Reporting
|
### Issue Reporting
|
||||||
- Bug reports and feature requests via [GitHub Issues](https://github.com/anthropics/claude-code/issues)
|
- Bug reports and feature requests via [GitHub Issues](https://github.com/anthropics/claude-code/issues) (external project)
|
||||||
- Security issues through responsible disclosure (see `SECURITY.md`)
|
- Security issues through responsible disclosure (see `SECURITY.md`)
|
||||||
|
|
||||||
### Community
|
### Community
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
To use Cordelia Taryne, [add her to your Discord account](https://discord.com/oauth2/authorize?client_id=1338664192714211459).
|
To use Cordelia Taryne, [add her to your Discord account](https://discord.com/oauth2/authorise?client_id=1338664192714211459).
|
||||||
|
|
||||||
### Available Commands
|
### Available Commands
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ Cordelia Taryne offers the following slash commands:
|
|||||||
|
|
||||||
#### `/summarise`
|
#### `/summarise`
|
||||||
- **Description**: Generate concise summaries of longer text passages
|
- **Description**: Generate concise summaries of longer text passages
|
||||||
- **Parameters**: `text` (required, max 2000 characters) - The text to summarize
|
- **Parameters**: `text` (required, max 2000 characters) - The text to summarise
|
||||||
- **Usage**: `/summarise text: [long article or document text]`
|
- **Usage**: `/summarise text: [long article or document text]`
|
||||||
- **Access**: Requires active subscription
|
- **Access**: Requires active subscription
|
||||||
|
|
||||||
@@ -76,9 +76,9 @@ Cordelia has a distinctive personality:
|
|||||||
|
|
||||||
### Support and Feedback
|
### Support and Feedback
|
||||||
|
|
||||||
- **Bug Reports**: Open a GitHub issue
|
- **Bug Reports**: Post in the #bug-reports forum channel on our Discord community
|
||||||
- **Feature Requests**: Create a GitHub issue with the enhancement label
|
- **Feature Requests**: Post in the #feature-requests forum channel on our Discord community
|
||||||
- **General Support**: Visit the [chat server](http://chat.nhcarrigan.com)
|
- **General Support**: Visit the [chat server](https://chat.nhcarrigan.com)
|
||||||
- **Contact**: Email `contact@nhcarrigan.com`
|
- **Contact**: Email `contact@nhcarrigan.com`
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
@@ -113,7 +113,7 @@ Required environment variables:
|
|||||||
|
|
||||||
1. **Clone the repository**:
|
1. **Clone the repository**:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/nhcarrigan/cordelia-taryne.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/cordelia-taryne.git
|
||||||
cd cordelia-taryne
|
cd cordelia-taryne
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -217,7 +217,7 @@ The Application integrates with:
|
|||||||
### Intellectual Property
|
### Intellectual Property
|
||||||
|
|
||||||
- Bot personality and character design are original creations
|
- Bot personality and character design are original creations
|
||||||
- Source code is licensed under Naomi's Public License
|
- Source code is licensed under Naomi's Public Licence
|
||||||
- Avatar and visual assets are proprietary
|
- Avatar and visual assets are proprietary
|
||||||
- AI model responses are generated by Anthropic's Claude
|
- AI model responses are generated by Anthropic's Claude
|
||||||
|
|
||||||
@@ -264,7 +264,7 @@ src/
|
|||||||
|
|
||||||
### Contribution Process
|
### Contribution Process
|
||||||
|
|
||||||
1. **Issue Creation**: Create detailed GitHub issues for bugs/features
|
1. **Issue Creation**: Post detailed bug reports or feature requests in the appropriate Discord forum channel (#bug-reports or #feature-requests)
|
||||||
2. **Discussion**: Discuss approach before starting work
|
2. **Discussion**: Discuss approach before starting work
|
||||||
3. **Implementation**: Follow coding standards and patterns
|
3. **Implementation**: Follow coding standards and patterns
|
||||||
4. **Testing**: Test thoroughly in development environment
|
4. **Testing**: Test thoroughly in development environment
|
||||||
|
|||||||
@@ -2,13 +2,13 @@
|
|||||||
title: Data API
|
title: Data API
|
||||||
---
|
---
|
||||||
|
|
||||||
Data API (hereinafter the "Application") is a lightweight web API server designed to host and serve personal and professional data for the NHCarrigan ecosystem. The Application acts as a centralized headless CMS, providing structured data in both YAML and JSON formats to power multiple websites, applications, and Discord bots.
|
Data API (hereinafter the "Application") is a lightweight web API server designed to host and serve personal and professional data for the NHCarrigan ecosystem. The Application acts as a centralised headless CMS, providing structured data in both YAML and JSON formats to power multiple websites, applications, and Discord bots.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 API Overview
|
### 1.1. API Overview
|
||||||
|
|
||||||
The Data Server provides a RESTful API that serves various categories of data through simple HTTP GET requests. All endpoints support both YAML and JSON formats.
|
The Data Server provides a RESTful API that serves various categories of data through simple HTTP GET requests. All endpoints support both YAML and JSON formats.
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ The Data Server provides a RESTful API that serves various categories of data th
|
|||||||
**Root Endpoint**:
|
**Root Endpoint**:
|
||||||
- `GET /` - Returns a welcome message: "Welcome to the NHCarrigan Data API!"
|
- `GET /` - Returns a welcome message: "Welcome to the NHCarrigan Data API!"
|
||||||
|
|
||||||
### 1.2 Available Endpoints
|
### 1.2. Available Endpoints
|
||||||
|
|
||||||
All data endpoints are available in two formats by changing the file extension:
|
All data endpoints are available in two formats by changing the file extension:
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ Contains professional testimonials and recommendations with:
|
|||||||
Contains details about donation platforms:
|
Contains details about donation platforms:
|
||||||
- Platform names and URLs
|
- Platform names and URLs
|
||||||
- Icon references
|
- Icon references
|
||||||
- Color schemes
|
- Colour schemes
|
||||||
- Platform descriptions
|
- Platform descriptions
|
||||||
|
|
||||||
#### Funding Information
|
#### Funding Information
|
||||||
@@ -74,21 +74,21 @@ Contains detailed funding information:
|
|||||||
- Subscription plan details
|
- Subscription plan details
|
||||||
- Financial history and records
|
- Financial history and records
|
||||||
|
|
||||||
### 1.3 CORS Support
|
### 1.3. CORS Support
|
||||||
|
|
||||||
The Application has CORS enabled for all origins, allowing consumption from any domain without cross-origin restrictions.
|
The Application has CORS enabled for all origins, allowing consumption from any domain without cross-origin restrictions.
|
||||||
|
|
||||||
### 1.4 Content Types
|
### 1.4. Content Types
|
||||||
|
|
||||||
The Application automatically sets appropriate Content-Type headers:
|
The Application automatically sets appropriate Content-Type headers:
|
||||||
- JSON endpoints: `application/json`
|
- JSON endpoints: `application/json`
|
||||||
- YAML endpoints: `text/yaml` or `application/x-yaml`
|
- YAML endpoints: `text/yaml` or `application/x-yaml`
|
||||||
|
|
||||||
### 1.5 Rate Limiting
|
### 1.5. Rate Limiting
|
||||||
|
|
||||||
Currently, the Application does not implement rate limiting. Users should be respectful of the server resources and avoid excessive requests.
|
Currently, the Application does not implement rate limiting. Users should be respectful of the server resources and avoid excessive requests.
|
||||||
|
|
||||||
### 1.6 Data Freshness
|
### 1.6. Data Freshness
|
||||||
|
|
||||||
Data is compiled from YAML source files during the build process. To receive updated data, the server must be rebuilt and restarted when source data changes.
|
Data is compiled from YAML source files during the build process. To receive updated data, the server must be rebuilt and restarted when source data changes.
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ Data is compiled from YAML source files during the build process. To receive upd
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Prerequisites
|
### 2.1. Prerequisites
|
||||||
|
|
||||||
Before running the Application, ensure you have the following installed:
|
Before running the Application, ensure you have the following installed:
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ Before running the Application, ensure you have the following installed:
|
|||||||
- **pnpm**: Version 10.17.0 (specified in package.json as packageManager)
|
- **pnpm**: Version 10.17.0 (specified in package.json as packageManager)
|
||||||
- **1Password CLI** (optional): For secure environment variable management in production
|
- **1Password CLI** (optional): For secure environment variable management in production
|
||||||
|
|
||||||
### 2.2 Technology Stack
|
### 2.2. Technology Stack
|
||||||
|
|
||||||
- **Runtime**: Node.js with ES modules
|
- **Runtime**: Node.js with ES modules
|
||||||
- **Language**: TypeScript 5.9.2
|
- **Language**: TypeScript 5.9.2
|
||||||
@@ -114,7 +114,7 @@ Before running the Application, ensure you have the following installed:
|
|||||||
- **Linting**: ESLint 9.36.0
|
- **Linting**: ESLint 9.36.0
|
||||||
- **Package Manager**: pnpm 10.17.0
|
- **Package Manager**: pnpm 10.17.0
|
||||||
|
|
||||||
### 2.3 Installation
|
### 2.3. Installation
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
@@ -127,7 +127,7 @@ cd data
|
|||||||
pnpm install
|
pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.4 Project Structure
|
### 2.4. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
/data/
|
/data/
|
||||||
@@ -157,7 +157,7 @@ pnpm install
|
|||||||
└── package.json # Project metadata and scripts
|
└── package.json # Project metadata and scripts
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.5 Configuration
|
### 2.5. Configuration
|
||||||
|
|
||||||
The Application uses the following configuration points:
|
The Application uses the following configuration points:
|
||||||
|
|
||||||
@@ -176,7 +176,7 @@ The Application uses the following configuration points:
|
|||||||
- Location: `src/index.ts:30`
|
- Location: `src/index.ts:30`
|
||||||
- Can be restricted by modifying the Fastify CORS configuration
|
- Can be restricted by modifying the Fastify CORS configuration
|
||||||
|
|
||||||
### 2.6 Data Management
|
### 2.6. Data Management
|
||||||
|
|
||||||
#### Adding New Data Endpoints
|
#### Adding New Data Endpoints
|
||||||
|
|
||||||
@@ -205,7 +205,7 @@ export interface NewData {
|
|||||||
|
|
||||||
The YAML files are the source of truth. Always edit YAML files, not JSON files, as JSON files are auto-generated.
|
The YAML files are the source of truth. Always edit YAML files, not JSON files, as JSON files are auto-generated.
|
||||||
|
|
||||||
### 2.7 Build Process
|
### 2.7. Build Process
|
||||||
|
|
||||||
The build process consists of two steps:
|
The build process consists of two steps:
|
||||||
|
|
||||||
@@ -224,7 +224,7 @@ To run the complete build:
|
|||||||
pnpm run build
|
pnpm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.8 Available Scripts
|
### 2.8. Available Scripts
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build (YAML → JSON + TypeScript compilation)
|
# Build (YAML → JSON + TypeScript compilation)
|
||||||
@@ -243,7 +243,7 @@ pnpm run lint:spelling # Spell check YAML files
|
|||||||
pnpm run lint:yaml # YAML validation
|
pnpm run lint:yaml # YAML validation
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.9 Testing
|
### 2.9. Testing
|
||||||
|
|
||||||
The Application includes comprehensive test coverage using Vitest.
|
The Application includes comprehensive test coverage using Vitest.
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ pnpm test
|
|||||||
|
|
||||||
Tests have a 120-second timeout to accommodate URL validation checks, which may be rate-limited.
|
Tests have a 120-second timeout to accommodate URL validation checks, which may be rate-limited.
|
||||||
|
|
||||||
### 2.10 Development Workflow
|
### 2.10. Development Workflow
|
||||||
|
|
||||||
1. **Make changes to data**:
|
1. **Make changes to data**:
|
||||||
- Edit YAML files in `/data` directory
|
- Edit YAML files in `/data` directory
|
||||||
@@ -296,7 +296,7 @@ Tests have a 120-second timeout to accommodate URL validation checks, which may
|
|||||||
curl http://localhost:9999/projects.json
|
curl http://localhost:9999/projects.json
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.11 Deployment
|
### 2.11. Deployment
|
||||||
|
|
||||||
#### Environment Variables
|
#### Environment Variables
|
||||||
|
|
||||||
@@ -327,7 +327,7 @@ Create a `prod.env` file with 1Password references for any required environment
|
|||||||
|
|
||||||
4. **Backups**: Regularly backup the `/data` directory, as it contains the source YAML files.
|
4. **Backups**: Regularly backup the `/data` directory, as it contains the source YAML files.
|
||||||
|
|
||||||
### 2.12 Troubleshooting
|
### 2.12. Troubleshooting
|
||||||
|
|
||||||
#### Server won't start
|
#### Server won't start
|
||||||
- Verify port 9999 is not in use
|
- Verify port 9999 is not in use
|
||||||
@@ -348,7 +348,7 @@ Create a `prod.env` file with 1Password references for any required environment
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 Data Usage and Privacy
|
### 3.1. Data Usage and Privacy
|
||||||
|
|
||||||
#### Data Served by the Application
|
#### Data Served by the Application
|
||||||
|
|
||||||
@@ -372,7 +372,7 @@ The Application itself does not collect, store, or process any personal data fro
|
|||||||
|
|
||||||
By enabling CORS for all origins, the Application explicitly permits third-party websites and applications to access the served data. This is intentional and by design, as the data is meant for public consumption.
|
By enabling CORS for all origins, the Application explicitly permits third-party websites and applications to access the served data. This is intentional and by design, as the data is meant for public consumption.
|
||||||
|
|
||||||
### 3.2 Data Accuracy and Updates
|
### 3.2. Data Accuracy and Updates
|
||||||
|
|
||||||
The data served by the Application is maintained on a best-effort basis. While efforts are made to ensure accuracy:
|
The data served by the Application is maintained on a best-effort basis. While efforts are made to ensure accuracy:
|
||||||
|
|
||||||
@@ -385,7 +385,7 @@ Users consuming this data should:
|
|||||||
- Cache responses responsibly
|
- Cache responses responsibly
|
||||||
- Not rely on the Application for time-sensitive or critical decisions
|
- Not rely on the Application for time-sensitive or critical decisions
|
||||||
|
|
||||||
### 3.3 Service Availability
|
### 3.3. Service Availability
|
||||||
|
|
||||||
The Application is provided "as-is" without guarantees of:
|
The Application is provided "as-is" without guarantees of:
|
||||||
- Continuous availability
|
- Continuous availability
|
||||||
@@ -395,26 +395,26 @@ The Application is provided "as-is" without guarantees of:
|
|||||||
|
|
||||||
Users should not build critical systems that depend on the Application's availability without implementing appropriate fallbacks and error handling.
|
Users should not build critical systems that depend on the Application's availability without implementing appropriate fallbacks and error handling.
|
||||||
|
|
||||||
### 3.4 Intellectual Property
|
### 3.4. Intellectual Property
|
||||||
|
|
||||||
#### Data Content
|
#### Data Content
|
||||||
|
|
||||||
The data served by the Application contains information about projects, professional experience, and other content that may be subject to intellectual property rights:
|
The data served by the Application contains information about projects, professional experience, and other content that may be subject to intellectual property rights:
|
||||||
|
|
||||||
- Project names, descriptions, and logos may be trademarks
|
- Project names, descriptions, and logos may be trademarks
|
||||||
- Code and software referenced may be under various open-source licenses
|
- Code and software referenced may be under various open-source licences
|
||||||
- Testimonial content remains the intellectual property of the original authors
|
- Testimonial content remains the intellectual property of the original authors
|
||||||
|
|
||||||
Users consuming this data should:
|
Users consuming this data should:
|
||||||
- Respect intellectual property rights
|
- Respect intellectual property rights
|
||||||
- Provide proper attribution when displaying data
|
- Provide proper attribution when displaying data
|
||||||
- Review specific licenses for any referenced projects or software
|
- Review specific licences for any referenced projects or software
|
||||||
|
|
||||||
#### Application Code
|
#### Application Code
|
||||||
|
|
||||||
The Application's source code is licensed under the terms specified in the LICENSE.md file. Copyright is held by Naomi Carrigan.
|
The Application's source code is licensed under the terms specified in the LICENSE.md file. Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
### 3.5 Terms of Service
|
### 3.5. Terms of Service
|
||||||
|
|
||||||
The general Terms of Service can be found at: https://docs.nhcarrigan.com/#/terms
|
The general Terms of Service can be found at: https://docs.nhcarrigan.com/#/terms
|
||||||
|
|
||||||
@@ -426,7 +426,7 @@ Users of the Application agree to:
|
|||||||
- Not attempt to exploit vulnerabilities or security weaknesses
|
- Not attempt to exploit vulnerabilities or security weaknesses
|
||||||
- Respect the intended public use of the data
|
- Respect the intended public use of the data
|
||||||
|
|
||||||
### 3.6 Privacy Policy
|
### 3.6. Privacy Policy
|
||||||
|
|
||||||
The general Privacy Policy can be found at: https://docs.nhcarrigan.com/#/privacy
|
The general Privacy Policy can be found at: https://docs.nhcarrigan.com/#/privacy
|
||||||
|
|
||||||
@@ -440,19 +440,19 @@ As noted in section 3.1, the Application does not collect user data. The privacy
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 General Contributing Guidelines
|
### 4.1. General Contributing Guidelines
|
||||||
|
|
||||||
General contributing guidelines can be found at: https://docs.nhcarrigan.com/#/contributing
|
General contributing guidelines can be found at: https://docs.nhcarrigan.com/#/contributing
|
||||||
|
|
||||||
Please review these guidelines before contributing to the Application.
|
Please review these guidelines before contributing to the Application.
|
||||||
|
|
||||||
### 4.2 Code of Conduct
|
### 4.2. Code of Conduct
|
||||||
|
|
||||||
Before interacting with the project or community, please read the [Code of Conduct](CODE_OF_CONDUCT.md).
|
Before interacting with the project or community, please read the [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
### 4.3 Ways to Contribute
|
### 4.3. Ways to Contribute
|
||||||
|
|
||||||
#### 4.3.1 Data Contributions
|
#### 4.3.1. Data Contributions
|
||||||
|
|
||||||
If you have corrections or updates to the data served by the Application:
|
If you have corrections or updates to the data served by the Application:
|
||||||
|
|
||||||
@@ -460,14 +460,14 @@ If you have corrections or updates to the data served by the Application:
|
|||||||
2. **Testimonials**: If you'd like to add a testimonial, please contact through the official channels
|
2. **Testimonials**: If you'd like to add a testimonial, please contact through the official channels
|
||||||
3. **Project updates**: For updates to project information, verify you have permission to modify the data
|
3. **Project updates**: For updates to project information, verify you have permission to modify the data
|
||||||
|
|
||||||
#### 4.3.2 Code Contributions
|
#### 4.3.2. Code Contributions
|
||||||
|
|
||||||
Contributors can help improve the Application in several ways:
|
Contributors can help improve the Application in several ways:
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- Enhanced API endpoints
|
- Enhanced API endpoints
|
||||||
- New data validation rules
|
- New data validation rules
|
||||||
- Performance optimizations
|
- Performance optimisations
|
||||||
- Additional data format support
|
- Additional data format support
|
||||||
- API documentation improvements
|
- API documentation improvements
|
||||||
|
|
||||||
@@ -483,7 +483,7 @@ Contributors can help improve the Application in several ways:
|
|||||||
- Documentation enhancements
|
- Documentation enhancements
|
||||||
- Type safety improvements
|
- Type safety improvements
|
||||||
|
|
||||||
### 4.4 Development Setup
|
### 4.4. Development Setup
|
||||||
|
|
||||||
1. **Fork and clone** the repository
|
1. **Fork and clone** the repository
|
||||||
2. **Install dependencies**: `pnpm install`
|
2. **Install dependencies**: `pnpm install`
|
||||||
@@ -495,7 +495,7 @@ Contributors can help improve the Application in several ways:
|
|||||||
8. **Commit and push** your changes
|
8. **Commit and push** your changes
|
||||||
9. **Open a Pull Request**
|
9. **Open a Pull Request**
|
||||||
|
|
||||||
### 4.5 Code Style Guidelines
|
### 4.5. Code Style Guidelines
|
||||||
|
|
||||||
#### TypeScript
|
#### TypeScript
|
||||||
|
|
||||||
@@ -531,7 +531,7 @@ export const processData = (input) => {
|
|||||||
- Provide meaningful error messages
|
- Provide meaningful error messages
|
||||||
- Handle errors gracefully without crashing the server
|
- Handle errors gracefully without crashing the server
|
||||||
|
|
||||||
### 4.6 Testing Guidelines
|
### 4.6. Testing Guidelines
|
||||||
|
|
||||||
All contributions should maintain or improve test coverage.
|
All contributions should maintain or improve test coverage.
|
||||||
|
|
||||||
@@ -564,7 +564,7 @@ Before submitting a PR:
|
|||||||
pnpm test # Run all tests
|
pnpm test # Run all tests
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.7 Documentation Guidelines
|
### 4.7. Documentation Guidelines
|
||||||
|
|
||||||
When contributing documentation:
|
When contributing documentation:
|
||||||
|
|
||||||
@@ -573,7 +573,7 @@ When contributing documentation:
|
|||||||
- Update relevant sections when changing functionality
|
- Update relevant sections when changing functionality
|
||||||
- Check spelling with `pnpm run lint:spelling`
|
- Check spelling with `pnpm run lint:spelling`
|
||||||
|
|
||||||
### 4.8 Pull Request Process
|
### 4.8. Pull Request Process
|
||||||
|
|
||||||
1. **Ensure all checks pass**:
|
1. **Ensure all checks pass**:
|
||||||
- All tests pass (`pnpm test`)
|
- All tests pass (`pnpm test`)
|
||||||
@@ -592,7 +592,7 @@ When contributing documentation:
|
|||||||
|
|
||||||
4. **Squash commits** if requested to maintain a clean git history
|
4. **Squash commits** if requested to maintain a clean git history
|
||||||
|
|
||||||
### 4.9 Adding New Data Categories
|
### 4.9. Adding New Data Categories
|
||||||
|
|
||||||
To add a new data category to the Application:
|
To add a new data category to the Application:
|
||||||
|
|
||||||
@@ -634,7 +634,7 @@ To add a new data category to the Application:
|
|||||||
curl http://localhost:9999/newcategory.json
|
curl http://localhost:9999/newcategory.json
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.10 Security Considerations
|
### 4.10. Security Considerations
|
||||||
|
|
||||||
When contributing, keep security in mind:
|
When contributing, keep security in mind:
|
||||||
|
|
||||||
@@ -643,20 +643,19 @@ When contributing, keep security in mind:
|
|||||||
- Follow secure coding practices
|
- Follow secure coding practices
|
||||||
- Report security vulnerabilities privately before opening public issues
|
- Report security vulnerabilities privately before opening public issues
|
||||||
|
|
||||||
### 4.11 Getting Help
|
### 4.11. Getting Help
|
||||||
|
|
||||||
If you need help contributing:
|
If you need help contributing:
|
||||||
|
|
||||||
- Open a GitHub issue with your question
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Join the [Chat Server](http://chat.nhcarrigan.com)
|
- Join the [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email: `contact@nhcarrigan.com`
|
- Email: `contact@nhcarrigan.com`
|
||||||
|
|
||||||
### 4.12 Recognition
|
### 4.12. Recognition
|
||||||
|
|
||||||
All contributors will be recognized for their contributions. Significant contributions may be highlighted in release notes and project documentation.
|
All contributors will be recognised for their contributions. Significant contributions may be highlighted in release notes and project documentation.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: 2025-10-29
|
|
||||||
**Application Version**: 1.0.0
|
**Application Version**: 1.0.0
|
||||||
**Maintained by**: NHCarrigan
|
**Maintained by**: NHCarrigan
|
||||||
|
|||||||
@@ -155,7 +155,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
The Application is licensed under [Naomi's Public License](https://docs.nhcarrigan.com/#/license) (referenced as "global software license").
|
The Application is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/#/license) (referenced as "global software licence").
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -224,13 +224,13 @@ The project uses:
|
|||||||
|
|
||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
|
|
||||||
If you have feedback or a bug report, please open a GitHub issue.
|
If you have feedback or a bug report, please post in the #bug-reports forum channel on our Discord community.
|
||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
|
|
||||||
The maintainers may be contacted through:
|
The maintainers may be contacted through:
|
||||||
|
|
||||||
- [Chat Server](http://chat.nhcarrigan.com)
|
- [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
### Current Version
|
### Current Version
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
title: NHCarrigan Documentation
|
title: NHCarrigan Documentation
|
||||||
---
|
---
|
||||||
|
|
||||||
NHCarrigan Documentation (hereinafter the "Application") is a comprehensive documentation website built with Astro and Starlight that serves as the central hub for all documentation related to NHCarrigan's projects, policies, and services. The site provides organized access to technical documentation, legal policies, community guidelines, and project-specific information across multiple categories including Discord bots, web applications, libraries, and development tools. The Application features a custom-themed interface with accessibility considerations, analytics integration, and environmental sustainability features.
|
NHCarrigan Documentation (hereinafter the "Application") is a comprehensive documentation website built with Astro and Starlight that serves as the central hub for all documentation related to NHCarrigan's projects, policies, and services. The site provides organised access to technical documentation, legal policies, community guidelines, and project-specific information across multiple categories including Discord bots, web applications, libraries, and development tools. The Application features a custom-themed interface with accessibility considerations, analytics integration, and environmental sustainability features.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
### Site Structure and Navigation
|
### Site Structure and Navigation
|
||||||
|
|
||||||
The Application is organized into several main sections accessible via the sidebar navigation:
|
The Application is organised into several main sections accessible via the sidebar navigation:
|
||||||
|
|
||||||
- **About Us**: Mission statement, sustainability information, hiring, donations, contact, and mentorship
|
- **About Us**: Mission statement, sustainability information, hiring, donations, contact, and mentorship
|
||||||
- **Legal Information**: Terms of service, privacy policy, software license, security policy, DMCA information, subprocessors list, and government actions
|
- **Legal Information**: Terms of service, privacy policy, software licence, security policy, DMCA information, subprocessors list, and government actions
|
||||||
- **Community Policies**: Code of conduct, community guidelines, and appeal process
|
- **Community Policies**: Code of conduct, community guidelines, and appeal process
|
||||||
- **Development Documentation**: Contributing guide, contributor covenant, style guide, issue/PR labels, development environment, server setup, and VTubing setup
|
- **Development Documentation**: Contributing guide, contributor covenant, style guide, issue/PR labels, development environment, server setup, and VTubing setup
|
||||||
- **Project Documentation**: Comprehensive documentation for all NHCarrigan projects including Discord bots, web applications, libraries, and tools
|
- **Project Documentation**: Comprehensive documentation for all NHCarrigan projects including Discord bots, web applications, libraries, and tools
|
||||||
@@ -22,18 +22,18 @@ The Application is organized into several main sections accessible via the sideb
|
|||||||
|
|
||||||
#### Custom Theming
|
#### Custom Theming
|
||||||
- Light and dark mode support with automatic detection
|
- Light and dark mode support with automatic detection
|
||||||
- Custom "Sakura Dreams" color scheme with pink/purple tones
|
- Custom "Sakura Dreams" colour scheme with pink/purple tones
|
||||||
- Accessibility features including OpenDyslexic font support
|
- Accessibility features including OpenDyslexic font support
|
||||||
- Responsive design that works across all devices
|
- Responsive design that works across all devices
|
||||||
|
|
||||||
#### Enhanced Footer
|
#### Enhanced Footer
|
||||||
- TreeNation carbon offset widget integration for environmental sustainability
|
- TreeNation carbon offset widget integration for environmental sustainability
|
||||||
- Direct donation link for supporting the organization
|
- Direct donation link for supporting the organisation
|
||||||
- Standard Starlight navigation elements (edit links, last updated, pagination)
|
- Standard Starlight navigation elements (edit links, last updated, pagination)
|
||||||
|
|
||||||
#### Analytics and Tracking
|
#### Analytics and Tracking
|
||||||
- Privacy-focused Plausible Analytics integration
|
- Privacy-focused Plausible Analytics integration
|
||||||
- Page view and event tracking for user behavior insights
|
- Page view and event tracking for user behaviour insights
|
||||||
- Google AdSense integration for monetization
|
- Google AdSense integration for monetization
|
||||||
|
|
||||||
#### Content Features
|
#### Content Features
|
||||||
@@ -47,7 +47,7 @@ The Application is organized into several main sections accessible via the sideb
|
|||||||
The Application includes several accessibility features:
|
The Application includes several accessibility features:
|
||||||
- Semantic HTML structure with proper heading hierarchy
|
- Semantic HTML structure with proper heading hierarchy
|
||||||
- OpenDyslexic font support for users with dyslexia
|
- OpenDyslexic font support for users with dyslexia
|
||||||
- High contrast color schemes
|
- High contrast colour schemes
|
||||||
- Keyboard navigation support
|
- Keyboard navigation support
|
||||||
- Screen reader compatible markup
|
- Screen reader compatible markup
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ The Application is built using modern web technologies:
|
|||||||
- **Framework**: Astro 5.3.0 - Static site generator for optimal performance
|
- **Framework**: Astro 5.3.0 - Static site generator for optimal performance
|
||||||
- **Theme**: Starlight 0.32.0 - Documentation-focused Astro integration
|
- **Theme**: Starlight 0.32.0 - Documentation-focused Astro integration
|
||||||
- **Language**: TypeScript 5.7.3 - Type-safe development
|
- **Language**: TypeScript 5.7.3 - Type-safe development
|
||||||
- **Build Tool**: Native Astro build system with minification and optimization
|
- **Build Tool**: Native Astro build system with minification and optimisation
|
||||||
- **Package Manager**: PNPM (evidenced by pnpm-lock.yaml)
|
- **Package Manager**: PNPM (evidenced by pnpm-lock.yaml)
|
||||||
- **Hosting**: Static deployment to https://docs.nhcarrigan.com
|
- **Hosting**: Static deployment to https://docs.nhcarrigan.com
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ public/ # Static assets
|
|||||||
- Hierarchical sidebar navigation structure
|
- Hierarchical sidebar navigation structure
|
||||||
- Project status badges with version information
|
- Project status badges with version information
|
||||||
- External links to community resources
|
- External links to community resources
|
||||||
- Organized categorization of all documentation
|
- Organized categorisation of all documentation
|
||||||
|
|
||||||
### Custom Components
|
### Custom Components
|
||||||
|
|
||||||
@@ -135,9 +135,9 @@ public/ # Static assets
|
|||||||
### Styling System
|
### Styling System
|
||||||
|
|
||||||
#### CSS Variables and Theming
|
#### CSS Variables and Theming
|
||||||
- Custom color scheme using CSS variables
|
- Custom colour scheme using CSS variables
|
||||||
- Pink/purple "Sakura Dreams" theme
|
- Pink/purple "Sakura Dreams" theme
|
||||||
- Dark mode with inverted color palette
|
- Dark mode with inverted colour palette
|
||||||
- Background image integration for visual appeal
|
- Background image integration for visual appeal
|
||||||
|
|
||||||
#### Typography
|
#### Typography
|
||||||
@@ -173,7 +173,7 @@ public/ # Static assets
|
|||||||
|
|
||||||
#### Social and Community
|
#### Social and Community
|
||||||
- Links to self-hosted Git instance (git.nhcarrigan.com)
|
- Links to self-hosted Git instance (git.nhcarrigan.com)
|
||||||
- Forum integration (forum.nhcarrigan.com)
|
- Discord community integration (chat.nhcarrigan.com)
|
||||||
|
|
||||||
### Performance and SEO
|
### Performance and SEO
|
||||||
|
|
||||||
@@ -195,14 +195,14 @@ The Application serves as the central repository for all legal documentation rel
|
|||||||
### Comprehensive Legal Coverage
|
### Comprehensive Legal Coverage
|
||||||
- **Terms of Service**: User agreements for all NHCarrigan services
|
- **Terms of Service**: User agreements for all NHCarrigan services
|
||||||
- **Privacy Policy**: Data collection, processing, and user rights
|
- **Privacy Policy**: Data collection, processing, and user rights
|
||||||
- **Software License**: Open source licensing for projects
|
- **Software Licence**: Open source licensing for projects
|
||||||
- **Security Policy**: Vulnerability reporting and security practices
|
- **Security Policy**: Vulnerability reporting and security practices
|
||||||
- **DMCA and Copyright**: Intellectual property policies
|
- **DMCA and Copyright**: Intellectual property policies
|
||||||
- **Subprocessors List**: Third-party service providers and data processing
|
- **Subprocessors List**: Third-party service providers and data processing
|
||||||
- **Government Actions**: Transparency reporting for legal requests
|
- **Government Actions**: Transparency reporting for legal requests
|
||||||
|
|
||||||
### Policy Management
|
### Policy Management
|
||||||
- Centralized location for all legal documents
|
- Centralised location for all legal documents
|
||||||
- Version control through Git for policy changes
|
- Version control through Git for policy changes
|
||||||
- Public accessibility for transparency
|
- Public accessibility for transparency
|
||||||
- Regular updates reflecting current legal requirements
|
- Regular updates reflecting current legal requirements
|
||||||
@@ -272,7 +272,7 @@ The Application serves as the central repository for all legal documentation rel
|
|||||||
- Update project version badges
|
- Update project version badges
|
||||||
- Refresh project screenshots
|
- Refresh project screenshots
|
||||||
- Review and update legal documents
|
- Review and update legal documents
|
||||||
- Monitor analytics for user behavior insights
|
- Monitor analytics for user behaviour insights
|
||||||
- Update dependencies and security patches
|
- Update dependencies and security patches
|
||||||
|
|
||||||
#### Community Involvement
|
#### Community Involvement
|
||||||
|
|||||||
@@ -132,7 +132,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
- Manages WebSocket connection to Deepgram
|
- Manages WebSocket connection to Deepgram
|
||||||
- Handles audio streaming in real-time
|
- Handles audio streaming in real-time
|
||||||
- Event-based architecture for message handling
|
- Event-based architecture for message handling
|
||||||
- Supports keep-alive and finalization
|
- Supports keep-alive and finalisation
|
||||||
- Configuration options:
|
- Configuration options:
|
||||||
- Model: nova-3-general
|
- Model: nova-3-general
|
||||||
- Language: configurable source language
|
- Language: configurable source language
|
||||||
@@ -229,7 +229,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under the [global software license](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under the [global software licence](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -343,21 +343,20 @@ Before interacting with our community, please read our [Code of Conduct](CODE_OF
|
|||||||
|
|
||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
|
|
||||||
If you have feedback or a bug report, please feel free to open a GitHub issue with:
|
If you have feedback or a bug report, please post in the #bug-reports forum channel on our Discord community with:
|
||||||
- Clear description of the issue
|
- Clear description of the issue
|
||||||
- Steps to reproduce (for bugs)
|
- Steps to reproduce (for bugs)
|
||||||
- Expected vs actual behavior
|
- Expected vs actual behaviour
|
||||||
- Browser and OS information
|
- Browser and OS information
|
||||||
- Screenshots if applicable
|
- Screenshots if applicable
|
||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
|
|
||||||
We may be contacted through:
|
We may be contacted through:
|
||||||
- [Chat Server](http://chat.nhcarrigan.com)
|
- [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Version**: 1.1.0
|
**Version**: 1.1.0
|
||||||
**Last Updated**: 2025-10-31
|
|
||||||
**Author**: Naomi Carrigan
|
**Author**: Naomi Carrigan
|
||||||
|
|||||||
@@ -181,4 +181,4 @@ If you instead see a failed run with ESlint errors (not linter errors, but packa
|
|||||||
|
|
||||||
Once that has passed successfully (including resolving any linter flags), you can proceed to running `pnpm test` to ensure the existing unit tests pass (and any tests you added to cover new plugins).
|
Once that has passed successfully (including resolving any linter flags), you can proceed to running `pnpm test` to ensure the existing unit tests pass (and any tests you added to cover new plugins).
|
||||||
|
|
||||||
As always, feel free to reach out to us on the [forum](https://forum.nhcarrigan.com) if you have any questions!~
|
As always, feel free to reach out to us in our [Discord community](https://chat.nhcarrigan.com) if you have any questions!~
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ The Application generates a compiled PDF document containing all review pages fr
|
|||||||
|
|
||||||
- A custom cover page with generation date
|
- A custom cover page with generation date
|
||||||
- An automatically generated table of contents with links to each review section
|
- An automatically generated table of contents with links to each review section
|
||||||
- All review content organized according to the curriculum structure
|
- All review content organised according to the curriculum structure
|
||||||
- Custom headers and footers for easy navigation
|
- Custom headers and footers for easy navigation
|
||||||
- Page numbers and links to community resources
|
- Page numbers and links to community resources
|
||||||
|
|
||||||
@@ -108,12 +108,12 @@ fcc-review-generator/
|
|||||||
|
|
||||||
#### PDF Customization
|
#### PDF Customization
|
||||||
|
|
||||||
Modify `src/config/options.ts` to customize:
|
Modify `src/config/options.ts` to customise:
|
||||||
- Page size and margins
|
- Page size and margins
|
||||||
- Header and footer templates
|
- Header and footer templates
|
||||||
- Styling and formatting
|
- Styling and formatting
|
||||||
|
|
||||||
Modify `src/config/text.ts` to customize:
|
Modify `src/config/text.ts` to customise:
|
||||||
- Cover page content
|
- Cover page content
|
||||||
- Introduction text
|
- Introduction text
|
||||||
- Disclaimer text
|
- Disclaimer text
|
||||||
@@ -234,7 +234,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. The full license text can be found at:
|
This software is licensed under Naomi's Public Licence. The full licence text can be found at:
|
||||||
- Local: [LICENSE.md](LICENSE.md)
|
- Local: [LICENSE.md](LICENSE.md)
|
||||||
- Online: https://docs.nhcarrigan.com/#/license
|
- Online: https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
@@ -290,16 +290,16 @@ We welcome contributions to the freeCodeCamp Review Generator! Before contributi
|
|||||||
|
|
||||||
#### 1. Report Bugs
|
#### 1. Report Bugs
|
||||||
|
|
||||||
If you encounter a bug, please open a GitHub issue with:
|
If you encounter a bug, please post in the #bug-reports forum channel on our Discord community with:
|
||||||
- Clear description of the problem
|
- Clear description of the problem
|
||||||
- Steps to reproduce
|
- Steps to reproduce
|
||||||
- Expected vs. actual behavior
|
- Expected vs. actual behaviour
|
||||||
- Your environment (OS, Node.js version, pnpm version)
|
- Your environment (OS, Node.js version, pnpm version)
|
||||||
- Any relevant error messages or logs
|
- Any relevant error messages or logs
|
||||||
|
|
||||||
#### 2. Suggest Enhancements
|
#### 2. Suggest Enhancements
|
||||||
|
|
||||||
We appreciate feature requests and enhancement suggestions! Please open a GitHub issue describing:
|
We appreciate feature requests and enhancement suggestions! Please post in the #feature-requests forum channel on our Discord community describing:
|
||||||
- The problem you're trying to solve
|
- The problem you're trying to solve
|
||||||
- Your proposed solution
|
- Your proposed solution
|
||||||
- Any alternative approaches you've considered
|
- Any alternative approaches you've considered
|
||||||
@@ -368,7 +368,7 @@ All source files should include the copyright header:
|
|||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright NHCarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
@@ -421,18 +421,18 @@ Please be patient during the review process and be open to feedback and requeste
|
|||||||
|
|
||||||
For questions, discussions, or help with contributions:
|
For questions, discussions, or help with contributions:
|
||||||
|
|
||||||
- **GitHub Issues**: For bug reports and feature requests
|
- **Discord Forum**: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- **Pull Requests**: For code contributions and discussions
|
- **Pull Requests**: For code contributions and discussions
|
||||||
- **Discord**: Join the community at http://chat.nhcarrigan.com
|
- **Discord**: Join the community at https://chat.nhcarrigan.com
|
||||||
- **Email**: contact@nhcarrigan.com for private inquiries
|
- **Email**: contact@nhcarrigan.com for private inquiries
|
||||||
|
|
||||||
### Recognition
|
### Recognition
|
||||||
|
|
||||||
All contributors will be recognized for their contributions. Significant contributions may result in being listed in a CONTRIBUTORS file or project documentation.
|
All contributors will be recognised for their contributions. Significant contributions may result in being listed in a CONTRIBUTORS file or project documentation.
|
||||||
|
|
||||||
### License for Contributions
|
### License for Contributions
|
||||||
|
|
||||||
By contributing to this project, you agree that your contributions will be licensed under the same license as the project (Naomi's Public License). You confirm that:
|
By contributing to this project, you agree that your contributions will be licensed under the same license as the project (Naomi's Public Licence). You confirm that:
|
||||||
|
|
||||||
- You have the right to submit the contribution
|
- You have the right to submit the contribution
|
||||||
- Your contribution is your original work or properly attributed
|
- Your contribution is your original work or properly attributed
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
To use Gwen Abalise, [add her to your Discord server](https://discord.com/oauth2/authorize?client_id=1343413943447584819).
|
To use Gwen Abalise, [add her to your Discord server](https://discord.com/oauth2/authorise?client_id=1343413943447584819).
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Hikari
|
title: Hikari
|
||||||
---
|
---
|
||||||
|
|
||||||
Hikari (hereinafter the "Application") is a centralized platform for managing NHCarrigan's products and services. It consists of three main components: a Discord bot with AI capabilities, an Angular web client for dashboard management, and a Fastify server backend. The platform enables users to manage their accounts, subscriptions, licenses, product configurations, and provides an AI-powered support agent for assistance with NHCarrigan's ecosystem of products.
|
Hikari (hereinafter the "Application") is a centralised platform for managing NHCarrigan's products and services. It consists of three main components: a Discord bot with AI capabilities, an Angular web client for dashboard management, and a Fastify server backend. The platform enables users to manage their accounts, subscriptions, licenses, product configurations, and provides an AI-powered support agent for assistance with NHCarrigan's ecosystem of products.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ The Hikari Discord bot provides the following functionality:
|
|||||||
|
|
||||||
The web dashboard provides a user-friendly interface for:
|
The web dashboard provides a user-friendly interface for:
|
||||||
|
|
||||||
- **Product Browsing**: View all available products categorized by type (Community Tools, Websites/APIs, Apps/Games)
|
- **Product Browsing**: View all available products categorised by type (Community Tools, Websites/APIs, Apps/Games)
|
||||||
- **Announcements**: Stay updated with the latest product updates and community news
|
- **Announcements**: Stay updated with the latest product updates and community news
|
||||||
- **Account Management**: Manage your subscriptions, licenses, and configurations
|
- **Account Management**: Manage your subscriptions, licenses, and configurations
|
||||||
- **Product Filtering**: Filter products by category or view all products at once
|
- **Product Filtering**: Filter products by category or view all products at once
|
||||||
@@ -35,7 +35,7 @@ The web dashboard provides a user-friendly interface for:
|
|||||||
|
|
||||||
1. **Discord Bot**: Install Hikari from the Discord app directory or invite to your server
|
1. **Discord Bot**: Install Hikari from the Discord app directory or invite to your server
|
||||||
2. **Web Dashboard**: Visit [hikari.nhcarrigan.com](https://hikari.nhcarrigan.com) to access the dashboard
|
2. **Web Dashboard**: Visit [hikari.nhcarrigan.com](https://hikari.nhcarrigan.com) to access the dashboard
|
||||||
3. **Support**: Join the [Discord community](https://chat.nhcarrigan.com) or visit the [forum](https://forum.nhcarrigan.com) for additional help
|
3. **Support**: Join the [Discord community](https://chat.nhcarrigan.com) for additional help
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ Hikari follows a microservices architecture with three main components:
|
|||||||
- **Language**: TypeScript
|
- **Language**: TypeScript
|
||||||
- **Key Features**:
|
- **Key Features**:
|
||||||
- Responsive web interface
|
- Responsive web interface
|
||||||
- Product catalog with filtering
|
- Product catalogue with filtering
|
||||||
- Announcements system
|
- Announcements system
|
||||||
- Routing and navigation
|
- Routing and navigation
|
||||||
|
|
||||||
@@ -69,7 +69,7 @@ Hikari follows a microservices architecture with three main components:
|
|||||||
- RESTful API endpoints
|
- RESTful API endpoints
|
||||||
- Announcement management
|
- Announcement management
|
||||||
- Database operations
|
- Database operations
|
||||||
- Discord and forum integration
|
- Discord integration
|
||||||
|
|
||||||
### Development Setup
|
### Development Setup
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ Hikari follows a microservices architecture with three main components:
|
|||||||
#### Installation
|
#### Installation
|
||||||
```bash
|
```bash
|
||||||
# Clone the repository
|
# Clone the repository
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/hikari
|
git clone https://git.nhcarrigan.com/NHCarrigan/hikari
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pnpm install
|
pnpm install
|
||||||
@@ -140,7 +140,7 @@ model Announcements {
|
|||||||
|
|
||||||
### Key Configuration Files
|
### Key Configuration Files
|
||||||
|
|
||||||
- [`client/src/app/config/products.ts`](client/src/app/config/products.ts) - Product catalog configuration
|
- [`client/src/app/config/products.ts`](client/src/app/config/products.ts) - Product catalogue configuration
|
||||||
- [`bot/src/config/prompt.ts`](bot/src/config/prompt.ts) - AI agent personality and instructions
|
- [`bot/src/config/prompt.ts`](bot/src/config/prompt.ts) - AI agent personality and instructions
|
||||||
- [`client/src/app/app.routes.ts`](client/src/app/app.routes.ts) - Client-side routing
|
- [`client/src/app/app.routes.ts`](client/src/app/app.routes.ts) - Client-side routing
|
||||||
- [`bot/commandJson.js`](bot/commandJson.js) - Discord slash command definitions
|
- [`bot/commandJson.js`](bot/commandJson.js) - Discord slash command definitions
|
||||||
@@ -163,7 +163,7 @@ turbo test
|
|||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
### License
|
### License
|
||||||
This software is licensed under [Naomi's Public License](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
### Privacy Policy
|
### Privacy Policy
|
||||||
User data handling is governed by the [NHCarrigan Privacy Policy](https://docs.nhcarrigan.com/#/privacy).
|
User data handling is governed by the [NHCarrigan Privacy Policy](https://docs.nhcarrigan.com/#/privacy).
|
||||||
@@ -192,11 +192,11 @@ Security vulnerabilities should be reported according to the [NHCarrigan Securit
|
|||||||
All contributors must follow the [NHCarrigan Code of Conduct](https://docs.nhcarrigan.com/community/coc/).
|
All contributors must follow the [NHCarrigan Code of Conduct](https://docs.nhcarrigan.com/community/coc/).
|
||||||
|
|
||||||
### Contributing Guidelines
|
### Contributing Guidelines
|
||||||
Please review the [Contributing Guidelines](https://docs.nhcarrigan.com/community/guide/) before submitting contributions.
|
Please review the [Contributing Guidelines](https://docs.nhcarrigan.com/dev/contributing/) before submitting contributions.
|
||||||
|
|
||||||
### Development Workflow
|
### Development Workflow
|
||||||
|
|
||||||
1. **Issue Creation**: Use the provided templates in [`.gitea/issue_template/`](.gitea/issue_template/)
|
1. **Issue Creation**: Post in the appropriate Discord forum channel (#bug-reports or #feature-requests) on our Discord community
|
||||||
2. **Pull Requests**: Follow the template in [`.gitea/pull_request_template.yml`](.gitea/pull_request_template.yml)
|
2. **Pull Requests**: Follow the template in [`.gitea/pull_request_template.yml`](.gitea/pull_request_template.yml)
|
||||||
3. **Code Standards**:
|
3. **Code Standards**:
|
||||||
- ESLint configuration enforced
|
- ESLint configuration enforced
|
||||||
@@ -241,5 +241,4 @@ hikari/
|
|||||||
|
|
||||||
### Getting Help
|
### Getting Help
|
||||||
- **Discord Community**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
- **Discord Community**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
||||||
- **Forum**: [forum.nhcarrigan.com](https://forum.nhcarrigan.com)
|
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
|
|||||||
@@ -145,11 +145,11 @@ The AI model configuration is set in the codebase (src/modules/makeAiRequest.ts:
|
|||||||
|
|
||||||
#### Personality Customization
|
#### Personality Customization
|
||||||
|
|
||||||
Edit `src/config/personality.ts` to customize Keiko's personality and behavior.
|
Edit `src/config/personality.ts` to customise Keiko's personality and behaviour.
|
||||||
|
|
||||||
#### User Authorization
|
#### User Authorization
|
||||||
|
|
||||||
Update `src/utils/isNaomi.ts:15` to configure authorized user IDs and SKU IDs for subscription management.
|
Update `src/utils/isNaomi.ts:15` to configure authorised user IDs and SKU IDs for subscription management.
|
||||||
|
|
||||||
### 2.5. Building the Application
|
### 2.5. Building the Application
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### 3.1. License
|
### 3.1. License
|
||||||
|
|
||||||
This software is licensed under [Naomi's Public License](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -287,7 +287,7 @@ Copyright held by Naomi Carrigan.
|
|||||||
#### Data Collection
|
#### Data Collection
|
||||||
|
|
||||||
Keiko collects and processes the following data:
|
Keiko collects and processes the following data:
|
||||||
- Discord user IDs for authorization
|
- Discord user IDs for authorisation
|
||||||
- Message content for conversation context (last 20 messages)
|
- Message content for conversation context (last 20 messages)
|
||||||
- Discord entitlement information for subscription management
|
- Discord entitlement information for subscription management
|
||||||
- Analytics data (message counts, token usage, API costs)
|
- Analytics data (message counts, token usage, API costs)
|
||||||
@@ -312,7 +312,7 @@ User messages and conversation context are sent to these services for processing
|
|||||||
#### Authorized Use
|
#### Authorized Use
|
||||||
|
|
||||||
- Keiko is a private assistant primarily designed for Naomi's personal use
|
- Keiko is a private assistant primarily designed for Naomi's personal use
|
||||||
- Subscription-based access is available for authorized users
|
- Subscription-based access is available for authorised users
|
||||||
- Unauthorized access attempts will be rejected
|
- Unauthorized access attempts will be rejected
|
||||||
|
|
||||||
#### Service Availability
|
#### Service Availability
|
||||||
@@ -412,7 +412,7 @@ Potential areas where contributions are welcome:
|
|||||||
- **Documentation**: Improve or expand documentation
|
- **Documentation**: Improve or expand documentation
|
||||||
- **Features**: Add new commands or capabilities
|
- **Features**: Add new commands or capabilities
|
||||||
- **Bug Fixes**: Fix reported issues
|
- **Bug Fixes**: Fix reported issues
|
||||||
- **Performance**: Optimize existing functionality
|
- **Performance**: Optimise existing functionality
|
||||||
- **Error Handling**: Improve error messages and handling
|
- **Error Handling**: Improve error messages and handling
|
||||||
|
|
||||||
### 4.8. Reporting Issues
|
### 4.8. Reporting Issues
|
||||||
@@ -424,7 +424,7 @@ If you find a bug or have a feature request:
|
|||||||
- Clear title
|
- Clear title
|
||||||
- Description of the problem or feature
|
- Description of the problem or feature
|
||||||
- Steps to reproduce (for bugs)
|
- Steps to reproduce (for bugs)
|
||||||
- Expected vs actual behavior
|
- Expected vs actual behaviour
|
||||||
- Environment details (if applicable)
|
- Environment details (if applicable)
|
||||||
|
|
||||||
### 4.9. Getting Help
|
### 4.9. Getting Help
|
||||||
|
|||||||
@@ -8,15 +8,15 @@ Liora (hereinafter the "Application") is a Discord bot that provides a "highligh
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Getting Started
|
### 1.1. Getting Started
|
||||||
|
|
||||||
To use Liora in your Discord server, you'll need to:
|
To use Liora in your Discord server, you'll need to:
|
||||||
|
|
||||||
1. **Add the bot to your server**: Visit the [invite link](https://discord.com/oauth2/authorize?client_id=1391492296222179459)
|
1. **Add the bot to your server**: Visit the [invite link](https://discord.com/oauth2/authorise?client_id=1391492296222179459)
|
||||||
2. **Subscribe to premium**: A server administrator must purchase a server subscription from the Discord store, unless your server is whitelisted
|
2. **Subscribe to premium**: A server administrator must purchase a server subscription from the Discord store, unless your server is whitelisted
|
||||||
3. **Enable DMs**: Ensure you have direct messages enabled from server members to receive notifications
|
3. **Enable DMs**: Ensure you have direct messages enabled from server members to receive notifications
|
||||||
|
|
||||||
### 1.2 Available Commands
|
### 1.2. Available Commands
|
||||||
|
|
||||||
The Application provides the following slash commands:
|
The Application provides the following slash commands:
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ Displays all your configured highlight words for the current server.
|
|||||||
#### `/dm`
|
#### `/dm`
|
||||||
Tests whether the bot can send you direct messages. Use this command if you're not receiving notifications to verify your DM settings are correct.
|
Tests whether the bot can send you direct messages. Use this command if you're not receiving notifications to verify your DM settings are correct.
|
||||||
|
|
||||||
### 1.3 Notification Format
|
### 1.3. Notification Format
|
||||||
|
|
||||||
When a message contains one of your highlight words, you'll receive a DM containing:
|
When a message contains one of your highlight words, you'll receive a DM containing:
|
||||||
|
|
||||||
@@ -56,25 +56,24 @@ When a message contains one of your highlight words, you'll receive a DM contain
|
|||||||
- Action buttons:
|
- Action buttons:
|
||||||
- **Jump to Message**: Opens the message in Discord
|
- **Jump to Message**: Opens the message in Discord
|
||||||
- **Discord Server**: Links to the support server
|
- **Discord Server**: Links to the support server
|
||||||
- **Forum**: Links to the support forum
|
- **Discord Community**: Links to the Discord community
|
||||||
|
|
||||||
### 1.4 Important Notes
|
### 1.4. Important Notes
|
||||||
|
|
||||||
- You will **not** receive notifications for messages you send yourself
|
- You will **not** receive notifications for messages you send yourself
|
||||||
- Highlight matching is **case-insensitive** (e.g., "discord" matches "Discord", "DISCORD", etc.)
|
- Highlight matching is **case-insensitive** (e.g., "discord" matches "Discord", "DISCORD", etc.)
|
||||||
- Highlights are **server-specific** - each server has its own separate list
|
- Highlights are **server-specific** - each server has its own separate list
|
||||||
- The bot requires the ability to send you DMs - check your privacy settings if notifications aren't working
|
- The bot requires the ability to send you DMs - check your privacy settings if notifications aren't working
|
||||||
|
|
||||||
### 1.5 Support and Feedback
|
### 1.5. Support and Feedback
|
||||||
|
|
||||||
If you need assistance or want to report a bug:
|
If you need assistance or want to report a bug:
|
||||||
|
|
||||||
- **Discord Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
- **Discord Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
||||||
- **Forum**: [forum.nhcarrigan.com](https://forum.nhcarrigan.com)
|
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
- **GitHub Issues**: Open an issue on the repository
|
- **Discord Forum**: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
|
|
||||||
### 1.6 Subscription Information
|
### 1.6. Subscription Information
|
||||||
|
|
||||||
The Application uses Discord's premium subscription system. Server administrators can purchase a subscription to enable the bot for all members. Two servers are currently whitelisted for free access (Naomi's server and FreeCodeCamp).
|
The Application uses Discord's premium subscription system. Server administrators can purchase a subscription to enable the bot for all members. Two servers are currently whitelisted for free access (Naomi's server and FreeCodeCamp).
|
||||||
|
|
||||||
@@ -84,7 +83,7 @@ The Application uses Discord's premium subscription system. Server administrator
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 System Requirements
|
### 2.1. System Requirements
|
||||||
|
|
||||||
- **Node.js**: v22 or higher
|
- **Node.js**: v22 or higher
|
||||||
- **Package Manager**: pnpm 10.13.1 or higher
|
- **Package Manager**: pnpm 10.13.1 or higher
|
||||||
@@ -92,7 +91,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
- **Discord**: Bot token from Discord Developer Portal
|
- **Discord**: Bot token from Discord Developer Portal
|
||||||
- **1Password CLI** (optional): For secure environment variable management
|
- **1Password CLI** (optional): For secure environment variable management
|
||||||
|
|
||||||
### 2.2 Technology Stack
|
### 2.2. Technology Stack
|
||||||
|
|
||||||
#### Core Technologies
|
#### Core Technologies
|
||||||
- **Runtime**: Node.js v22
|
- **Runtime**: Node.js v22
|
||||||
@@ -111,7 +110,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
- **Prisma** (v6.12.0): Database schema management
|
- **Prisma** (v6.12.0): Database schema management
|
||||||
- **TypeScript**: Type safety and compilation
|
- **TypeScript**: Type safety and compilation
|
||||||
|
|
||||||
### 2.3 Architecture Overview
|
### 2.3. Architecture Overview
|
||||||
|
|
||||||
The Application follows an event-driven architecture:
|
The Application follows an event-driven architecture:
|
||||||
|
|
||||||
@@ -161,7 +160,7 @@ src/
|
|||||||
**Command Handlers**:
|
**Command Handlers**:
|
||||||
All commands use Discord's Components V2 API with ContainerBuilder and TextDisplayBuilder for rich formatting.
|
All commands use Discord's Components V2 API with ContainerBuilder and TextDisplayBuilder for rich formatting.
|
||||||
|
|
||||||
### 2.4 Database Schema
|
### 2.4. Database Schema
|
||||||
|
|
||||||
The Application uses MongoDB with Prisma ORM:
|
The Application uses MongoDB with Prisma ORM:
|
||||||
|
|
||||||
@@ -181,12 +180,12 @@ model Highlights {
|
|||||||
- The unique constraint ensures no duplicate user-server combinations
|
- The unique constraint ensures no duplicate user-server combinations
|
||||||
- The server ID is indexed for efficient queries when processing messages
|
- The server ID is indexed for efficient queries when processing messages
|
||||||
|
|
||||||
### 2.5 Installation and Setup
|
### 2.5. Installation and Setup
|
||||||
|
|
||||||
#### Step 1: Clone the Repository
|
#### Step 1: Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/liora.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/liora.git
|
||||||
cd liora
|
cd liora
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -257,7 +256,7 @@ The Application will:
|
|||||||
- Start the web server on port 5022
|
- Start the web server on port 5022
|
||||||
- Begin monitoring messages
|
- Begin monitoring messages
|
||||||
|
|
||||||
### 2.6 Development Workflow
|
### 2.6. Development Workflow
|
||||||
|
|
||||||
#### Linting
|
#### Linting
|
||||||
|
|
||||||
@@ -283,7 +282,7 @@ pnpm test
|
|||||||
|
|
||||||
Currently returns a placeholder. Test implementation is pending.
|
Currently returns a placeholder. Test implementation is pending.
|
||||||
|
|
||||||
### 2.7 Continuous Integration
|
### 2.7. Continuous Integration
|
||||||
|
|
||||||
The repository includes a Gitea Actions workflow (`.gitea/workflows/ci.yml`) that:
|
The repository includes a Gitea Actions workflow (`.gitea/workflows/ci.yml`) that:
|
||||||
- Runs on push and pull requests to the main branch
|
- Runs on push and pull requests to the main branch
|
||||||
@@ -291,7 +290,7 @@ The repository includes a Gitea Actions workflow (`.gitea/workflows/ci.yml`) tha
|
|||||||
- Verifies TypeScript compilation
|
- Verifies TypeScript compilation
|
||||||
- Runs tests
|
- Runs tests
|
||||||
|
|
||||||
### 2.8 Configuration
|
### 2.8. Configuration
|
||||||
|
|
||||||
#### Whitelisted Guilds
|
#### Whitelisted Guilds
|
||||||
|
|
||||||
@@ -309,7 +308,7 @@ The premium subscription SKU is defined in `src/utils/checkEntitlement.ts`. To u
|
|||||||
2. Update the SKU ID in the entitlement check logic
|
2. Update the SKU ID in the entitlement check logic
|
||||||
3. Rebuild the application
|
3. Rebuild the application
|
||||||
|
|
||||||
### 2.9 Deployment
|
### 2.9. Deployment
|
||||||
|
|
||||||
#### Web Server
|
#### Web Server
|
||||||
|
|
||||||
@@ -334,7 +333,7 @@ The Application includes a Fastify web server that:
|
|||||||
|
|
||||||
The web server on port 5022 can be used for health checks. A simple GET request to `/` will return the landing page HTML if the service is running.
|
The web server on port 5022 can be used for health checks. A simple GET request to `/` will return the landing page HTML if the service is running.
|
||||||
|
|
||||||
### 2.10 Analytics
|
### 2.10. Analytics
|
||||||
|
|
||||||
The Application integrates with a custom analytics service (@nhcarrigan/discord-analytics):
|
The Application integrates with a custom analytics service (@nhcarrigan/discord-analytics):
|
||||||
|
|
||||||
@@ -344,20 +343,20 @@ The Application integrates with a custom analytics service (@nhcarrigan/discord-
|
|||||||
- **Metadata**: Includes server ID, user ID, and matched words
|
- **Metadata**: Includes server ID, user ID, and matched words
|
||||||
- **Authentication**: Requires LOG_TOKEN environment variable
|
- **Authentication**: Requires LOG_TOKEN environment variable
|
||||||
|
|
||||||
### 2.11 API Endpoints
|
### 2.11. API Endpoints
|
||||||
|
|
||||||
The Fastify web server exposes:
|
The Fastify web server exposes:
|
||||||
|
|
||||||
- `GET /`: Landing page with bot information and "Add to Discord" link
|
- `GET /`: Landing page with bot information and "Add to Discord" link
|
||||||
|
|
||||||
### 2.12 Security Considerations
|
### 2.12. Security Considerations
|
||||||
|
|
||||||
- **Message Content Intent**: The bot requires access to read all message content in subscribed guilds. This is a privileged intent and should be handled responsibly.
|
- **Message Content Intent**: The bot requires access to read all message content in subscribed guilds. This is a privileged intent and should be handled responsibly.
|
||||||
- **Environment Variables**: Use secure methods to manage secrets (1Password CLI, environment variable management services, etc.)
|
- **Environment Variables**: Use secure methods to manage secrets (1Password CLI, environment variable management services, etc.)
|
||||||
- **DM Privacy**: The bot only sends DMs when highlights are triggered; it does not store message content
|
- **DM Privacy**: The bot only sends DMs when highlights are triggered; it does not store message content
|
||||||
- **Entitlement Validation**: All commands and message processing verify subscription status to prevent unauthorized usage
|
- **Entitlement Validation**: All commands and message processing verify subscription status to prevent unauthorised usage
|
||||||
|
|
||||||
### 2.13 Troubleshooting
|
### 2.13. Troubleshooting
|
||||||
|
|
||||||
#### Bot Not Responding to Commands
|
#### Bot Not Responding to Commands
|
||||||
- Verify the bot has appropriate permissions in the server
|
- Verify the bot has appropriate permissions in the server
|
||||||
@@ -383,13 +382,13 @@ The Fastify web server exposes:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
This software is licensed under [Naomi's Public License](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
### 3.2 Data Collection and Privacy
|
### 3.2. Data Collection and Privacy
|
||||||
|
|
||||||
The Application collects and stores the following data:
|
The Application collects and stores the following data:
|
||||||
|
|
||||||
@@ -413,7 +412,7 @@ The Application collects and stores the following data:
|
|||||||
- MongoDB: Database hosting
|
- MongoDB: Database hosting
|
||||||
- Custom Analytics Service: Usage metrics tracking
|
- Custom Analytics Service: Usage metrics tracking
|
||||||
|
|
||||||
### 3.3 Terms of Service
|
### 3.3. Terms of Service
|
||||||
|
|
||||||
By using the Application, you agree to:
|
By using the Application, you agree to:
|
||||||
|
|
||||||
@@ -422,7 +421,7 @@ By using the Application, you agree to:
|
|||||||
- Accept that the service is provided "as is" without warranties
|
- Accept that the service is provided "as is" without warranties
|
||||||
- Understand that subscription fees are non-refundable per Discord's policies
|
- Understand that subscription fees are non-refundable per Discord's policies
|
||||||
|
|
||||||
### 3.4 Acceptable Use
|
### 3.4. Acceptable Use
|
||||||
|
|
||||||
Users must not:
|
Users must not:
|
||||||
|
|
||||||
@@ -431,7 +430,7 @@ Users must not:
|
|||||||
- Exploit bugs or vulnerabilities in the Application
|
- Exploit bugs or vulnerabilities in the Application
|
||||||
- Use the Application for any illegal purposes
|
- Use the Application for any illegal purposes
|
||||||
|
|
||||||
### 3.5 Subscription Terms
|
### 3.5. Subscription Terms
|
||||||
|
|
||||||
- Subscriptions are managed through Discord's subscription system
|
- Subscriptions are managed through Discord's subscription system
|
||||||
- Pricing and billing are handled by Discord
|
- Pricing and billing are handled by Discord
|
||||||
@@ -439,7 +438,7 @@ Users must not:
|
|||||||
- Two servers are currently whitelisted for free access
|
- Two servers are currently whitelisted for free access
|
||||||
- Subscription status is validated before processing commands and notifications
|
- Subscription status is validated before processing commands and notifications
|
||||||
|
|
||||||
### 3.6 Liability
|
### 3.6. Liability
|
||||||
|
|
||||||
The Application maintainers are not liable for:
|
The Application maintainers are not liable for:
|
||||||
|
|
||||||
@@ -448,7 +447,7 @@ The Application maintainers are not liable for:
|
|||||||
- Service interruptions or downtime
|
- Service interruptions or downtime
|
||||||
- Actions taken by users based on notifications received
|
- Actions taken by users based on notifications received
|
||||||
|
|
||||||
### 3.7 Contact for Legal Inquiries
|
### 3.7. Contact for Legal Inquiries
|
||||||
|
|
||||||
For legal questions or concerns:
|
For legal questions or concerns:
|
||||||
|
|
||||||
@@ -459,25 +458,25 @@ For legal questions or concerns:
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Our comprehensive contributing guidelines can be found at: [https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing)
|
Our comprehensive contributing guidelines can be found at: [https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing)
|
||||||
|
|
||||||
### 4.2 Code of Conduct
|
### 4.2. Code of Conduct
|
||||||
|
|
||||||
Before interacting with our community, please review our Code of Conduct: [https://docs.nhcarrigan.com/#/coc](https://docs.nhcarrigan.com/#/coc)
|
Before interacting with our community, please review our Code of Conduct: [https://docs.nhcarrigan.com/#/coc](https://docs.nhcarrigan.com/#/coc)
|
||||||
|
|
||||||
### 4.3 How to Contribute
|
### 4.3. How to Contribute
|
||||||
|
|
||||||
#### Reporting Bugs
|
#### Reporting Bugs
|
||||||
|
|
||||||
If you encounter a bug:
|
If you encounter a bug:
|
||||||
|
|
||||||
1. Check existing GitHub issues to avoid duplicates
|
1. Post in the #bug-reports forum channel on our Discord community
|
||||||
2. Create a new issue with:
|
2. Include in your post:
|
||||||
- Clear description of the bug
|
- Clear description of the bug
|
||||||
- Steps to reproduce
|
- Steps to reproduce
|
||||||
- Expected vs. actual behavior
|
- Expected vs. actual behaviour
|
||||||
- Environment details (Node.js version, OS, etc.)
|
- Environment details (Node.js version, OS, etc.)
|
||||||
- Error logs or screenshots if applicable
|
- Error logs or screenshots if applicable
|
||||||
|
|
||||||
@@ -485,7 +484,7 @@ If you encounter a bug:
|
|||||||
|
|
||||||
For feature requests:
|
For feature requests:
|
||||||
|
|
||||||
1. Open a GitHub issue with the "feature request" label
|
1. Post in the #feature-requests forum channel on our Discord community
|
||||||
2. Describe the feature and its use case
|
2. Describe the feature and its use case
|
||||||
3. Explain why it would benefit users
|
3. Explain why it would benefit users
|
||||||
4. Be open to discussion and feedback
|
4. Be open to discussion and feedback
|
||||||
@@ -513,7 +512,7 @@ To contribute code:
|
|||||||
- Link to related issues
|
- Link to related issues
|
||||||
- Wait for review and address feedback
|
- Wait for review and address feedback
|
||||||
|
|
||||||
### 4.4 Development Setup
|
### 4.4. Development Setup
|
||||||
|
|
||||||
Follow the steps in Section 2.5 (Installation and Setup) to set up your development environment.
|
Follow the steps in Section 2.5 (Installation and Setup) to set up your development environment.
|
||||||
|
|
||||||
@@ -525,7 +524,7 @@ Follow the steps in Section 2.5 (Installation and Setup) to set up your developm
|
|||||||
- Use meaningful variable and function names
|
- Use meaningful variable and function names
|
||||||
- Add JSDoc comments for public functions and interfaces
|
- Add JSDoc comments for public functions and interfaces
|
||||||
|
|
||||||
### 4.5 Code Style Guidelines
|
### 4.5. Code Style Guidelines
|
||||||
|
|
||||||
The Application uses:
|
The Application uses:
|
||||||
|
|
||||||
@@ -542,7 +541,7 @@ Key conventions:
|
|||||||
- **Semicolons**: Required
|
- **Semicolons**: Required
|
||||||
- **Max line length**: Enforced by ESLint (exceptions allowed for long strings)
|
- **Max line length**: Enforced by ESLint (exceptions allowed for long strings)
|
||||||
|
|
||||||
### 4.6 Project Structure Guidelines
|
### 4.6. Project Structure Guidelines
|
||||||
|
|
||||||
When adding new features:
|
When adding new features:
|
||||||
|
|
||||||
@@ -552,7 +551,7 @@ When adding new features:
|
|||||||
- **Business Logic**: Add to `src/modules/` directory
|
- **Business Logic**: Add to `src/modules/` directory
|
||||||
- **Type Definitions**: Add to `src/interfaces/` directory
|
- **Type Definitions**: Add to `src/interfaces/` directory
|
||||||
|
|
||||||
### 4.7 Testing Guidelines
|
### 4.7. Testing Guidelines
|
||||||
|
|
||||||
Currently, the Application does not have automated tests. Contributions to add testing infrastructure are welcome!
|
Currently, the Application does not have automated tests. Contributions to add testing infrastructure are welcome!
|
||||||
|
|
||||||
@@ -565,7 +564,7 @@ Currently, the Application does not have automated tests. Contributions to add t
|
|||||||
- Test subscription validation
|
- Test subscription validation
|
||||||
- Check error handling
|
- Check error handling
|
||||||
|
|
||||||
### 4.8 Documentation Contributions
|
### 4.8. Documentation Contributions
|
||||||
|
|
||||||
Documentation improvements are highly valued! You can contribute by:
|
Documentation improvements are highly valued! You can contribute by:
|
||||||
|
|
||||||
@@ -575,32 +574,31 @@ Documentation improvements are highly valued! You can contribute by:
|
|||||||
- Translating documentation (if applicable)
|
- Translating documentation (if applicable)
|
||||||
- Adding diagrams or visual aids
|
- Adding diagrams or visual aids
|
||||||
|
|
||||||
### 4.9 Community Involvement
|
### 4.9. Community Involvement
|
||||||
|
|
||||||
Join our community:
|
Join our community:
|
||||||
|
|
||||||
- **Discord Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com) - Ask questions, discuss features
|
- **Discord Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com) - Ask questions, discuss features
|
||||||
- **Forum**: [forum.nhcarrigan.com](https://forum.nhcarrigan.com) - Long-form discussions and support
|
- **Discord Community**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com) - Long-form discussions and support
|
||||||
- **GitHub Issues**: Track bugs and feature requests
|
- **Discord Forum**: Post in the #bug-reports or #feature-requests forum channels for bugs and feature requests
|
||||||
|
|
||||||
### 4.10 Recognition
|
### 4.10. Recognition
|
||||||
|
|
||||||
Contributors will be recognized in:
|
Contributors will be recognised in:
|
||||||
|
|
||||||
- Git commit history
|
- Git commit history
|
||||||
- Release notes for significant contributions
|
- Release notes for significant contributions
|
||||||
- The community Discord server
|
- The community Discord server
|
||||||
|
|
||||||
### 4.11 Getting Help
|
### 4.11. Getting Help
|
||||||
|
|
||||||
If you need help while contributing:
|
If you need help while contributing:
|
||||||
|
|
||||||
- Ask in the Discord server (#development or #support channels)
|
- Ask in the Discord server (#development or #support channels)
|
||||||
- Post on the forum for detailed questions
|
- Post in the relevant Discord forum channel (#bug-reports or #feature-requests)
|
||||||
- Comment on the relevant GitHub issue or pull request
|
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
### 4.12 Release Process
|
### 4.12. Release Process
|
||||||
|
|
||||||
The Application follows semantic versioning (SemVer):
|
The Application follows semantic versioning (SemVer):
|
||||||
|
|
||||||
@@ -608,7 +606,7 @@ The Application follows semantic versioning (SemVer):
|
|||||||
- **Minor versions** (0.X.0): New features, backward compatible
|
- **Minor versions** (0.X.0): New features, backward compatible
|
||||||
- **Patch versions** (0.0.X): Bug fixes, backward compatible
|
- **Patch versions** (0.0.X): Bug fixes, backward compatible
|
||||||
|
|
||||||
**Current Version**: v1.0.0 (as of latest commit: ba5987e)
|
**Current Version**: v1.0.0
|
||||||
|
|
||||||
Releases are managed by the maintainers. Contributors should focus on feature branches and pull requests rather than version bumping.
|
Releases are managed by the maintainers. Contributors should focus on feature branches and pull requests rather than version bumping.
|
||||||
|
|
||||||
@@ -616,9 +614,8 @@ Releases are managed by the maintainers. Contributors should focus on feature br
|
|||||||
|
|
||||||
**Additional Resources**:
|
**Additional Resources**:
|
||||||
|
|
||||||
- **Live Bot**: [Add to Discord](https://discord.com/oauth2/authorize?client_id=1391492296222179459)
|
- **Live Bot**: [Add to Discord](https://discord.com/oauth2/authorise?client_id=1391492296222179459)
|
||||||
- **Source Code**: [Gitea Repository](https://git.nhcarrigan.com/nhcarrigan/liora)
|
- **Source Code**: [Gitea Repository](https://git.nhcarrigan.com/NHCarrigan/liora)
|
||||||
- **Documentation Hub**: [docs.nhcarrigan.com](https://docs.nhcarrigan.com)
|
- **Documentation Hub**: [docs.nhcarrigan.com](https://docs.nhcarrigan.com)
|
||||||
- **Support Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
- **Support Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
||||||
- **Support Forum**: [forum.nhcarrigan.com](https://forum.nhcarrigan.com)
|
|
||||||
- **Contact Email**: contact@nhcarrigan.com
|
- **Contact Email**: contact@nhcarrigan.com
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: "Logger"
|
title: "Logger"
|
||||||
---
|
---
|
||||||
|
|
||||||
Logger (hereinafter the "Application") is a custom logging utility that provides a wrapper around a custom alert monitoring server, enabling applications to pipe errors and log messages to a centralized alerting system.
|
Logger (hereinafter the "Application") is a custom logging utility that provides a wrapper around a custom alert monitoring server, enabling applications to pipe errors and log messages to a centralised alerting system.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -133,7 +133,7 @@ All requests require an `Authorization` header with your API token.
|
|||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/logger.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/logger.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
@@ -173,7 +173,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. See the [LICENSE.md](LICENSE.md) file for complete terms.
|
This software is licensed under Naomi's Public Licence. See the [LICENSE.md](LICENSE.md) file for complete terms.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
|
|
||||||
@@ -222,10 +222,10 @@ If you encounter bugs or have feature requests:
|
|||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
|
|
||||||
- Chat Server: [http://chat.nhcarrigan.com](http://chat.nhcarrigan.com)
|
- Chat Server: [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- Repository: [https://git.nhcarrigan.com/nhcarrigan/logger](https://git.nhcarrigan.com/nhcarrigan/logger)
|
- Repository: [https://git.nhcarrigan.com/nhcarrigan/logger](https://git.nhcarrigan.com/NHCarrigan/logger)
|
||||||
- Issues: [https://git.nhcarrigan.com/nhcarrigan/logger/issues](https://git.nhcarrigan.com/nhcarrigan/logger/issues)
|
- Issues: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
|
|
||||||
### Package Information
|
### Package Information
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Creates a new shortened URL.
|
|||||||
Displays all your active shortened URLs along with usage statistics.
|
Displays all your active shortened URLs along with usage statistics.
|
||||||
- **Features:**
|
- **Features:**
|
||||||
- Shows current usage count vs. subscription limit
|
- Shows current usage count vs. subscription limit
|
||||||
- Provides clickable buttons to access Discord server and forum
|
- Provides clickable buttons to access Discord server
|
||||||
- Lists all active short URLs with their destinations
|
- Lists all active short URLs with their destinations
|
||||||
|
|
||||||
#### `/remove`
|
#### `/remove`
|
||||||
@@ -129,7 +129,7 @@ Required environment variables:
|
|||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### Licensing
|
### Licensing
|
||||||
The Application is licensed under "Naomi's Public License" as indicated in the source code headers.
|
The Application is licensed under "Naomi's Public Licence" as indicated in the source code headers.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
Copyright held by Naomi Carrigan (@nhcarrigan).
|
Copyright held by Naomi Carrigan (@nhcarrigan).
|
||||||
@@ -176,7 +176,7 @@ src/
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Key Patterns
|
### Key Patterns
|
||||||
- Error handling with centralized `errorHandler`
|
- Error handling with centralised `errorHandler`
|
||||||
- Logging via `@nhcarrigan/logger`
|
- Logging via `@nhcarrigan/logger`
|
||||||
- Command pattern for Discord interactions
|
- Command pattern for Discord interactions
|
||||||
- Subscription-based access control
|
- Subscription-based access control
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Quick Start
|
### Quick Start
|
||||||
|
|
||||||
1. [Add Maylin to your Discord account](https://discord.com/oauth2/authorize?client_id=1343370633916059668)
|
1. [Add Maylin to your Discord account](https://discord.com/oauth2/authorise?client_id=1343370633916059668)
|
||||||
2. Use the `/dm` command to start a private conversation
|
2. Use the `/dm` command to start a private conversation
|
||||||
3. Send messages directly to Maylin in DMs for AI-powered companionship
|
3. Send messages directly to Maylin in DMs for AI-powered companionship
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ Maylin Taryne is built as a user-installable Discord bot with the following key
|
|||||||
- **Discord API**: discord.js v14
|
- **Discord API**: discord.js v14
|
||||||
- **AI Integration**: Anthropic Claude (claude-sonnet-4-20250514)
|
- **AI Integration**: Anthropic Claude (claude-sonnet-4-20250514)
|
||||||
- **Web Server**: Fastify for health monitoring
|
- **Web Server**: Fastify for health monitoring
|
||||||
- **Logging**: @nhcarrigan/logger for centralized logging
|
- **Logging**: @nhcarrigan/logger for centralised logging
|
||||||
- **Build System**: TypeScript compiler with ES modules
|
- **Build System**: TypeScript compiler with ES modules
|
||||||
|
|
||||||
#### Bot Architecture
|
#### Bot Architecture
|
||||||
@@ -76,7 +76,7 @@ Maylin Taryne is built as a user-installable Discord bot with the following key
|
|||||||
- **Subscription Validation**: Discord entitlement checking
|
- **Subscription Validation**: Discord entitlement checking
|
||||||
- **Cost Calculation**: Usage tracking and cost monitoring
|
- **Cost Calculation**: Usage tracking and cost monitoring
|
||||||
- **Error Handling**: Standardized error responses
|
- **Error Handling**: Standardized error responses
|
||||||
- **Logging**: Centralized logging infrastructure
|
- **Logging**: Centralised logging infrastructure
|
||||||
|
|
||||||
##### Server (`src/server/`)
|
##### Server (`src/server/`)
|
||||||
- Health monitoring web server on port 5011
|
- Health monitoring web server on port 5011
|
||||||
@@ -121,9 +121,9 @@ pnpm start
|
|||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### Licensing
|
### Licensing
|
||||||
- Licensed under Naomi's Public License
|
- Licensed under Naomi's Public Licence
|
||||||
- Copyright held by Naomi Carrigan
|
- Copyright held by Naomi Carrigan
|
||||||
- See [global software license](https://docs.nhcarrigan.com/#/license) for details
|
- See [global software licence](https://docs.nhcarrigan.com/#/license) for details
|
||||||
|
|
||||||
### Privacy Considerations
|
### Privacy Considerations
|
||||||
- All conversations occur in Discord direct messages
|
- All conversations occur in Discord direct messages
|
||||||
@@ -152,7 +152,7 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
- Modular architecture with clear separation of concerns
|
- Modular architecture with clear separation of concerns
|
||||||
- Event-driven design following Discord.js patterns
|
- Event-driven design following Discord.js patterns
|
||||||
- Utility-first approach for shared functionality
|
- Utility-first approach for shared functionality
|
||||||
- Configuration-driven personality and behavior
|
- Configuration-driven personality and behaviour
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
- Vitest for testing framework (configuration present)
|
- Vitest for testing framework (configuration present)
|
||||||
@@ -171,6 +171,6 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
- All contributions subject to review process
|
- All contributions subject to review process
|
||||||
|
|
||||||
### Support and Contact
|
### Support and Contact
|
||||||
- [Chat Server](http://chat.nhcarrigan.com) for community support
|
- [Chat Server](https://chat.nhcarrigan.com) for community support
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- [Source Code Repository](https://git.nhcarrigan.com/nhcarrigan/maylin-taryne)
|
- [Source Code Repository](https://git.nhcarrigan.com/NHCarrigan/maylin-taryne)
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Meeting Minutes
|
title: Meeting Minutes
|
||||||
---
|
---
|
||||||
|
|
||||||
Meeting Minutes (hereinafter the "Application") is a local, offline meeting recording, transcription, and summarization tool designed to protect user data privacy by processing all audio and text entirely on the user's machine without any external services or cloud processing.
|
Meeting Minutes (hereinafter the "Application") is a local, offline meeting recording, transcription, and summarisation tool designed to protect user data privacy by processing all audio and text entirely on the user's machine without any external services or cloud processing.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -10,13 +10,13 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
The Application automates the process of capturing, transcribing, and summarizing meeting audio. It operates entirely offline to ensure complete data privacy and confidentiality of your meeting discussions.
|
The Application automates the process of capturing, transcribing, and summarising meeting audio. It operates entirely offline to ensure complete data privacy and confidentiality of your meeting discussions.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- **Audio Recording**: Captures meeting audio from your system's default audio input/output mix
|
- **Audio Recording**: Captures meeting audio from your system's default audio input/output mix
|
||||||
- **Speech-to-Text Transcription**: Converts recorded audio to text using WhisperX (OpenAI's Whisper model)
|
- **Speech-to-Text Transcription**: Converts recorded audio to text using WhisperX (OpenAI's Whisper model)
|
||||||
- **AI Summarization**: Generates concise meeting summaries with key decisions, action items, and discussion points using a local LLM
|
- **AI Summarisation**: Generates concise meeting summaries with key decisions, action items, and discussion points using a local LLM
|
||||||
- **Speaker Diarization** (Optional): Identifies and labels different speakers in the meeting
|
- **Speaker Diarization** (Optional): Identifies and labels different speakers in the meeting
|
||||||
- **Complete Privacy**: All processing happens locally on your machine with no data transmission to external services
|
- **Complete Privacy**: All processing happens locally on your machine with no data transmission to external services
|
||||||
|
|
||||||
@@ -69,7 +69,7 @@ The Application requires the following external tools:
|
|||||||
|
|
||||||
1. **FFmpeg**: For audio recording and processing
|
1. **FFmpeg**: For audio recording and processing
|
||||||
2. **WhisperX**: For speech-to-text transcription
|
2. **WhisperX**: For speech-to-text transcription
|
||||||
3. **Ollama**: For local LLM-based summarization with llama3:8b model
|
3. **Ollama**: For local LLM-based summarisation with llama3:8b model
|
||||||
4. **uv**: Python package and environment manager
|
4. **uv**: Python package and environment manager
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
@@ -205,7 +205,7 @@ After the first successful run, you can remove the token from the code.
|
|||||||
The Application follows a linear pipeline architecture:
|
The Application follows a linear pipeline architecture:
|
||||||
|
|
||||||
```
|
```
|
||||||
Audio Input → Recording (FFmpeg) → Transcription (WhisperX) → Summarization (Ollama) → Cleanup
|
Audio Input → Recording (FFmpeg) → Transcription (WhisperX) → Summarisation (Ollama) → Cleanup
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Component Details
|
#### Component Details
|
||||||
@@ -221,7 +221,7 @@ Audio Input → Recording (FFmpeg) → Transcription (WhisperX) → Summarizatio
|
|||||||
- Generates timestamped JSON transcripts
|
- Generates timestamped JSON transcripts
|
||||||
- Optional speaker diarization support
|
- Optional speaker diarization support
|
||||||
|
|
||||||
**Summarization Module** (`summarize_with_local_model()` - main.py:39-74):
|
**Summarisation Module** (`summarize_with_local_model()` - main.py:39-74):
|
||||||
- Uses Ollama with llama3:8b for local AI processing
|
- Uses Ollama with llama3:8b for local AI processing
|
||||||
- Extracts key decisions, action items, and discussion points
|
- Extracts key decisions, action items, and discussion points
|
||||||
- Generates natural language summaries
|
- Generates natural language summaries
|
||||||
@@ -275,7 +275,7 @@ Modify the prompt in `summarize_with_local_model()` (lines 49-60) to adjust summ
|
|||||||
**Issue**: WhisperX fails to transcribe
|
**Issue**: WhisperX fails to transcribe
|
||||||
**Solution**: Ensure the audio file is valid WAV format and the Whisper model is downloaded
|
**Solution**: Ensure the audio file is valid WAV format and the Whisper model is downloaded
|
||||||
|
|
||||||
**Issue**: Summarization takes too long
|
**Issue**: Summarisation takes too long
|
||||||
**Solution**: Use a smaller/faster Ollama model or switch to GPU processing
|
**Solution**: Use a smaller/faster Ollama model or switch to GPU processing
|
||||||
|
|
||||||
**Issue**: No audio captured during recording
|
**Issue**: No audio captured during recording
|
||||||
@@ -295,7 +295,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
The Application is designed with privacy as a core principle:
|
The Application is designed with privacy as a core principle:
|
||||||
|
|
||||||
- **No External Data Transmission**: All audio recording, transcription, and summarization occurs locally on the user's machine
|
- **No External Data Transmission**: All audio recording, transcription, and summarisation occurs locally on the user's machine
|
||||||
- **No Cloud Services**: No APIs, cloud services, or external servers are contacted during operation
|
- **No Cloud Services**: No APIs, cloud services, or external servers are contacted during operation
|
||||||
- **User Control**: Users have complete control over all recorded data, transcripts, and summaries
|
- **User Control**: Users have complete control over all recorded data, transcripts, and summaries
|
||||||
- **Data Retention**: The Application automatically cleans up temporary files, retaining only the user-requested summary
|
- **Data Retention**: The Application automatically cleans up temporary files, retaining only the user-requested summary
|
||||||
@@ -318,7 +318,7 @@ Users of the Application must:
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under the [global software license](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under the [global software licence](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -374,12 +374,12 @@ We welcome contributions in the following areas:
|
|||||||
- Better error handling and user feedback
|
- Better error handling and user feedback
|
||||||
- Configuration file support (YAML/JSON) instead of hardcoded values
|
- Configuration file support (YAML/JSON) instead of hardcoded values
|
||||||
- Automated testing suite
|
- Automated testing suite
|
||||||
- Performance optimizations
|
- Performance optimisations
|
||||||
- Documentation improvements
|
- Documentation improvements
|
||||||
- Cross-platform compatibility testing
|
- Cross-platform compatibility testing
|
||||||
|
|
||||||
**Bug Fixes**:
|
**Bug Fixes**:
|
||||||
- Any identified issues in audio recording, transcription, or summarization
|
- Any identified issues in audio recording, transcription, or summarisation
|
||||||
- Platform-specific bugs
|
- Platform-specific bugs
|
||||||
- Edge cases in file handling
|
- Edge cases in file handling
|
||||||
|
|
||||||
@@ -389,7 +389,7 @@ When contributing, please test:
|
|||||||
|
|
||||||
1. **Audio Recording**: Verify recording works with various audio sources
|
1. **Audio Recording**: Verify recording works with various audio sources
|
||||||
2. **Transcription**: Test with different accents, speaking speeds, and audio quality
|
2. **Transcription**: Test with different accents, speaking speeds, and audio quality
|
||||||
3. **Summarization**: Ensure summaries are coherent and capture key information
|
3. **Summarisation**: Ensure summaries are coherent and capture key information
|
||||||
4. **Cross-platform**: Test on different operating systems if possible
|
4. **Cross-platform**: Test on different operating systems if possible
|
||||||
5. **Error Handling**: Test edge cases and error conditions
|
5. **Error Handling**: Test edge cases and error conditions
|
||||||
|
|
||||||
@@ -404,8 +404,8 @@ When contributing, please test:
|
|||||||
|
|
||||||
If you encounter bugs or have feature requests:
|
If you encounter bugs or have feature requests:
|
||||||
|
|
||||||
1. Check existing GitHub issues to avoid duplicates
|
1. Check existing posts in the #bug-reports or #feature-requests forum channels to avoid duplicates
|
||||||
2. Open a new issue with a clear title and description
|
2. Post in the appropriate forum channel with a clear title and description
|
||||||
3. Include steps to reproduce (for bugs)
|
3. Include steps to reproduce (for bugs)
|
||||||
4. Provide system information (OS, Python version, etc.)
|
4. Provide system information (OS, Python version, etc.)
|
||||||
|
|
||||||
@@ -413,8 +413,8 @@ If you encounter bugs or have feature requests:
|
|||||||
|
|
||||||
If you need assistance:
|
If you need assistance:
|
||||||
|
|
||||||
- Open a GitHub issue with the "question" label
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Join our [Chat Server](http://chat.nhcarrigan.com)
|
- Join our [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email us at `contact@nhcarrigan.com`
|
- Email us at `contact@nhcarrigan.com`
|
||||||
|
|
||||||
### Recognition
|
### Recognition
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Melody Iuvo
|
title: Melody Iuvo
|
||||||
---
|
---
|
||||||
|
|
||||||
Melody Iuvo (hereinafter the "Application") is a powerful task management bot for Discord that enables users to create, organize, and track their tasks, deadlines, and goals directly within Discord. The bot provides a comprehensive set of slash commands for task management with support for categories, priorities, status tracking, and due dates.
|
Melody Iuvo (hereinafter the "Application") is a powerful task management bot for Discord that enables users to create, organise, and track their tasks, deadlines, and goals directly within Discord. The bot provides a comprehensive set of slash commands for task management with support for categories, priorities, status tracking, and due dates.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
To use Melody Iuvo, you'll need to [add the bot to your Discord account](https://discord.com/oauth2/authorize?client_id=1338753576583041074) and subscribe to access the premium features.
|
To use Melody Iuvo, you'll need to [add the bot to your Discord account](https://discord.com/oauth2/authorise?client_id=1338753576583041074) and subscribe to access the premium features.
|
||||||
|
|
||||||
### Available Commands
|
### Available Commands
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ Tasks are displayed in rich Discord embeds showing:
|
|||||||
- Title and description
|
- Title and description
|
||||||
- Category, status, and priority
|
- Category, status, and priority
|
||||||
- Due date, creation date, and last updated date
|
- Due date, creation date, and last updated date
|
||||||
- Color-coded by status (red for TODO, orange for in-progress, yellow for in-review, green for complete)
|
- Colour-coded by status (red for TODO, orange for in-progress, yellow for in-review, green for complete)
|
||||||
|
|
||||||
### Subscription Model
|
### Subscription Model
|
||||||
|
|
||||||
|
|||||||
@@ -2,18 +2,18 @@
|
|||||||
title: Mommy Bot
|
title: Mommy Bot
|
||||||
---
|
---
|
||||||
|
|
||||||
Mommy Bot (hereinafter the "Application") is a multi-platform bot application that provides encouraging and supportive messages across Discord, Slack, and Bluesky platforms. The bot delivers personalized "mommy" messages to users, creating a comforting and nurturing interaction experience.
|
Mommy Bot (hereinafter the "Application") is a multi-platform bot application that provides encouraging and supportive messages across Discord, Slack, and Bluesky platforms. The bot delivers personalised "mommy" messages to users, creating a comforting and nurturing interaction experience.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
### Discord Usage
|
### Discord Usage
|
||||||
- [Install the app](https://discord.com/oauth2/authorize?client_id=1347642447643017289)
|
- [Install the app](https://discord.com/oauth2/authorise?client_id=1347642447643017289)
|
||||||
- Use the `/mommy` slash command
|
- Use the `/mommy` slash command
|
||||||
- Optionally provide a name parameter: `/mommy name:YourName`
|
- Optionally provide a name parameter: `/mommy name:YourName`
|
||||||
- The bot will respond with an encouraging message personalized to your name
|
- The bot will respond with an encouraging message personalised to your name
|
||||||
|
|
||||||
### Slack Usage
|
### Slack Usage
|
||||||
- [Install the app](https://slack.com/oauth/v2/authorize?client_id=8569765106322.8554301974567&scope=commands&user_scope=)
|
- [Install the app](https://slack.com/oauth/v2/authorise?client_id=8569765106322.8554301974567&scope=commands&user_scope=)
|
||||||
- Use the `/mommy` command in any channel where the bot is installed
|
- Use the `/mommy` command in any channel where the bot is installed
|
||||||
- Optionally provide a name: `/mommy YourName`
|
- Optionally provide a name: `/mommy YourName`
|
||||||
- The bot will respond with an encouraging message
|
- The bot will respond with an encouraging message
|
||||||
@@ -55,13 +55,13 @@ The Application is built using TypeScript and Node.js with the following key com
|
|||||||
**Message Generation (`src/utils/getMommy.ts`)**
|
**Message Generation (`src/utils/getMommy.ts`)**
|
||||||
- Fetches encouraging messages from external API
|
- Fetches encouraging messages from external API
|
||||||
- Implements profanity filtering using no-profanity library
|
- Implements profanity filtering using no-profanity library
|
||||||
- Supports personalized name insertion
|
- Supports personalised name insertion
|
||||||
- Defaults to "dear" for filtered or empty names
|
- Defaults to "dear" for filtered or empty names
|
||||||
|
|
||||||
**Logging (`src/utils/logger.ts`)**
|
**Logging (`src/utils/logger.ts`)**
|
||||||
- Uses @nhcarrigan/logger for structured logging
|
- Uses @nhcarrigan/logger for structured logging
|
||||||
- Configured with application name "Mommy"
|
- Configured with application name "Mommy"
|
||||||
- Supports remote log token for centralized logging
|
- Supports remote log token for centralised logging
|
||||||
|
|
||||||
#### Deployment
|
#### Deployment
|
||||||
- Built using TypeScript compiler (`npm run build`)
|
- Built using TypeScript compiler (`npm run build`)
|
||||||
@@ -81,10 +81,10 @@ Key production dependencies:
|
|||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
### License
|
### License
|
||||||
The Application is licensed under "Naomi's Public License" as specified in the source code headers.
|
The Application is licensed under "Naomi's Public Licence" as specified in the source code headers.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
All code is copyright © nhcarrigan (Naomi Carrigan).
|
All code is copyright © NHCarrigan (Naomi Carrigan).
|
||||||
|
|
||||||
### Third-Party Services
|
### Third-Party Services
|
||||||
The Application integrates with:
|
The Application integrates with:
|
||||||
@@ -154,5 +154,5 @@ src/
|
|||||||
Report bugs and feature requests through the project's issue tracker, including:
|
Report bugs and feature requests through the project's issue tracker, including:
|
||||||
- Platform affected (Discord/Slack/Bluesky)
|
- Platform affected (Discord/Slack/Bluesky)
|
||||||
- Steps to reproduce
|
- Steps to reproduce
|
||||||
- Expected vs. actual behavior
|
- Expected vs. actual behaviour
|
||||||
- Environment details
|
- Environment details
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Mommy
|
title: Mommy
|
||||||
---
|
---
|
||||||
|
|
||||||
Mommy (hereinafter the "Application") is a web-based application that provides users with supportive and loving messages, optionally personalized with their name. The Application uses a Fastify-based backend server that serves both a landing page and an API endpoint, delivering encouraging phrases with configurable "mommy" personas. It is designed for ease of use, accessibility, and providing emotional support through positive reinforcement.
|
Mommy (hereinafter the "Application") is a web-based application that provides users with supportive and loving messages, optionally personalised with their name. The Application uses a Fastify-based backend server that serves both a landing page and an API endpoint, delivering encouraging phrases with configurable "mommy" personas. It is designed for ease of use, accessibility, and providing emotional support through positive reinforcement.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -11,13 +11,13 @@ Mommy (hereinafter the "Application") is a web-based application that provides u
|
|||||||
The Mommy application provides a simple web interface for receiving encouraging messages:
|
The Mommy application provides a simple web interface for receiving encouraging messages:
|
||||||
|
|
||||||
1. **Visit the Application**: Navigate to the [Mommy web application](https://mommy.nhcarrigan.com) in your browser
|
1. **Visit the Application**: Navigate to the [Mommy web application](https://mommy.nhcarrigan.com) in your browser
|
||||||
2. **Optional Name Entry**: Enter your name in the text field if you'd like personalized messages
|
2. **Optional Name Entry**: Enter your name in the text field if you'd like personalised messages
|
||||||
3. **Request Love**: Click the "I need some love..." button to receive an encouraging message
|
3. **Request Love**: Click the "I need some love..." button to receive an encouraging message
|
||||||
4. **Receive Your Message**: A supportive phrase will appear, personalized with your name if provided
|
4. **Receive Your Message**: A supportive phrase will appear, personalised with your name if provided
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- **Personalized Messages**: Over 100 unique encouraging phrases that can be personalized with your name
|
- **Personalized Messages**: Over 100 unique encouraging phrases that can be personalised with your name
|
||||||
- **Accessibility-Focused Design**: Uses OpenDyslexic font and high-contrast styling for better readability
|
- **Accessibility-Focused Design**: Uses OpenDyslexic font and high-contrast styling for better readability
|
||||||
- **Mobile-Friendly**: Responsive design that works on all device sizes
|
- **Mobile-Friendly**: Responsive design that works on all device sizes
|
||||||
- **No Registration Required**: Instant access without any account creation
|
- **No Registration Required**: Instant access without any account creation
|
||||||
@@ -27,10 +27,10 @@ The Mommy application provides a simple web interface for receiving encouraging
|
|||||||
The application also provides a simple API:
|
The application also provides a simple API:
|
||||||
- **Endpoint**: `/api`
|
- **Endpoint**: `/api`
|
||||||
- **Method**: GET
|
- **Method**: GET
|
||||||
- **Optional Parameter**: `name` (string) - Your name for personalization
|
- **Optional Parameter**: `name` (string) - Your name for personalisation
|
||||||
- **Response**: Plain text encouraging message
|
- **Response**: Plain text encouraging message
|
||||||
|
|
||||||
Example: `GET /api?name=Alex` returns a personalized encouraging message.
|
Example: `GET /api?name=Alex` returns a personalised encouraging message.
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ src/
|
|||||||
|
|
||||||
The application uses Fastify to serve:
|
The application uses Fastify to serve:
|
||||||
1. **Landing Page** (`/`): Returns the complete HTML interface
|
1. **Landing Page** (`/`): Returns the complete HTML interface
|
||||||
2. **API Endpoint** (`/api`): Returns personalized encouraging messages
|
2. **API Endpoint** (`/api`): Returns personalised encouraging messages
|
||||||
|
|
||||||
### Message Generation
|
### Message Generation
|
||||||
|
|
||||||
@@ -121,14 +121,14 @@ The project includes comprehensive tests using Vitest:
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. Copyright held by Naomi Carrigan.
|
This software is licensed under Naomi's Public Licence. Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
### Privacy
|
### Privacy
|
||||||
|
|
||||||
The application:
|
The application:
|
||||||
- Does not store user data persistently
|
- Does not store user data persistently
|
||||||
- Does not use cookies or tracking
|
- Does not use cookies or tracking
|
||||||
- Processes names only for message personalization
|
- Processes names only for message personalisation
|
||||||
- Does not log personal information
|
- Does not log personal information
|
||||||
|
|
||||||
### Content Policy
|
### Content Policy
|
||||||
|
|||||||
@@ -8,15 +8,15 @@ Nomena (hereinafter the "Application") is a Discord bot that generates creative
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Overview
|
### 1.1. Overview
|
||||||
|
|
||||||
Nomena is a Discord bot designed to help generate creative project ideas. When mentioned in Discord, the bot generates fitting project names based on your description and creates a unique anime mascot image to serve as the project's avatar.
|
Nomena is a Discord bot designed to help generate creative project ideas. When mentioned in Discord, the bot generates fitting project names based on your description and creates a unique anime mascot image to serve as the project's avatar.
|
||||||
|
|
||||||
### 1.2 Access Requirements
|
### 1.2. Access Requirements
|
||||||
|
|
||||||
Currently, the Application is configured for single-user access. Users must be authorized by the bot owner to interact with Nomena. If you attempt to use the bot without authorization, you will receive a message indicating that the bot can only generate project ideas for authorized users.
|
Currently, the Application is configured for single-user access. Users must be authorised by the bot owner to interact with Nomena. If you attempt to use the bot without authorisation, you will receive a message indicating that the bot can only generate project ideas for authorised users.
|
||||||
|
|
||||||
### 1.3 How to Use
|
### 1.3. How to Use
|
||||||
|
|
||||||
#### Basic Usage
|
#### Basic Usage
|
||||||
|
|
||||||
@@ -50,14 +50,14 @@ The Application automatically checks against a database of existing project name
|
|||||||
|
|
||||||
In rare cases, image generation may fail due to API limitations or content restrictions. When this occurs, you will still receive the project names and descriptions, with a message indicating that the image could not be generated.
|
In rare cases, image generation may fail due to API limitations or content restrictions. When this occurs, you will still receive the project names and descriptions, with a message indicating that the image could not be generated.
|
||||||
|
|
||||||
### 1.4 Best Practices
|
### 1.4. Best Practices
|
||||||
|
|
||||||
- **Be Descriptive**: Provide clear, detailed descriptions of your project idea for better name suggestions
|
- **Be Descriptive**: Provide clear, detailed descriptions of your project idea for better name suggestions
|
||||||
- **Include Context**: Mention the project's purpose, target audience, or key features
|
- **Include Context**: Mention the project's purpose, target audience, or key features
|
||||||
- **One Request at a Time**: Wait for the bot to respond before sending additional requests
|
- **One Request at a Time**: Wait for the bot to respond before sending additional requests
|
||||||
- **Respect Rate Limits**: Avoid excessive requests in rapid succession
|
- **Respect Rate Limits**: Avoid excessive requests in rapid succession
|
||||||
|
|
||||||
### 1.5 Example Interactions
|
### 1.5. Example Interactions
|
||||||
|
|
||||||
**Request:**
|
**Request:**
|
||||||
```
|
```
|
||||||
@@ -82,14 +82,14 @@ Project Description: A mobile app for learning Japanese vocabulary through space
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 System Requirements
|
### 2.1. System Requirements
|
||||||
|
|
||||||
- **Node.js**: Version 18.x or higher
|
- **Node.js**: Version 18.x or higher
|
||||||
- **Package Manager**: pnpm 10.19.0 (recommended) or npm
|
- **Package Manager**: pnpm 10.19.0 (recommended) or npm
|
||||||
- **Operating System**: Linux, macOS, or Windows
|
- **Operating System**: Linux, macOS, or Windows
|
||||||
- **API Keys**: Valid API keys for required services (see Environment Variables)
|
- **API Keys**: Valid API keys for required services (see Environment Variables)
|
||||||
|
|
||||||
### 2.2 Technology Stack
|
### 2.2. Technology Stack
|
||||||
|
|
||||||
The Application is built with the following technologies:
|
The Application is built with the following technologies:
|
||||||
|
|
||||||
@@ -107,7 +107,7 @@ The Application is built with the following technologies:
|
|||||||
- **@nhcarrigan/logger** (v1.1.1): Custom logging utility with Discord Analytics integration
|
- **@nhcarrigan/logger** (v1.1.1): Custom logging utility with Discord Analytics integration
|
||||||
- **@nhcarrigan/discord-analytics** (v0.0.6): Analytics tracking
|
- **@nhcarrigan/discord-analytics** (v0.0.6): Analytics tracking
|
||||||
|
|
||||||
### 2.3 Installation
|
### 2.3. Installation
|
||||||
|
|
||||||
1. **Clone the repository:**
|
1. **Clone the repository:**
|
||||||
```bash
|
```bash
|
||||||
@@ -132,7 +132,7 @@ The Application is built with the following technologies:
|
|||||||
pnpm run build
|
pnpm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.4 Environment Variables
|
### 2.4. Environment Variables
|
||||||
|
|
||||||
Create a `prod.env` file in the project root with the following variables:
|
Create a `prod.env` file in the project root with the following variables:
|
||||||
|
|
||||||
@@ -158,7 +158,7 @@ LOG_TOKEN=your_log_token_here
|
|||||||
|
|
||||||
**All environment variables are required.** The Application will throw an error and refuse to start if any are missing.
|
**All environment variables are required.** The Application will throw an error and refuse to start if any are missing.
|
||||||
|
|
||||||
### 2.5 Discord Bot Configuration
|
### 2.5. Discord Bot Configuration
|
||||||
|
|
||||||
When creating your Discord bot at https://discord.com/developers/applications, ensure the following:
|
When creating your Discord bot at https://discord.com/developers/applications, ensure the following:
|
||||||
|
|
||||||
@@ -175,7 +175,7 @@ When creating your Discord bot at https://discord.com/developers/applications, e
|
|||||||
|
|
||||||
**Note:** The Message Content intent is a privileged intent and must be enabled in the Discord Developer Portal.
|
**Note:** The Message Content intent is a privileged intent and must be enabled in the Discord Developer Portal.
|
||||||
|
|
||||||
### 2.6 Customization
|
### 2.6. Customization
|
||||||
|
|
||||||
#### User Access Control
|
#### User Access Control
|
||||||
|
|
||||||
@@ -183,7 +183,7 @@ By default, the bot is configured for single-user access. To modify access contr
|
|||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
if (message.author.id !== "YOUR_DISCORD_USER_ID") {
|
if (message.author.id !== "YOUR_DISCORD_USER_ID") {
|
||||||
await message.reply("Sorry, I can only generate project ideas for authorized users.");
|
await message.reply("Sorry, I can only generate project ideas for authorised users.");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -192,7 +192,7 @@ You can:
|
|||||||
- Replace the user ID with your own Discord user ID
|
- Replace the user ID with your own Discord user ID
|
||||||
- Remove the check entirely to allow all users
|
- Remove the check entirely to allow all users
|
||||||
- Implement role-based access control
|
- Implement role-based access control
|
||||||
- Add a whitelist of authorized user IDs
|
- Add a whitelist of authorised user IDs
|
||||||
|
|
||||||
#### Bot Mention ID
|
#### Bot Mention ID
|
||||||
|
|
||||||
@@ -249,7 +249,7 @@ To disable the uniqueness check entirely, comment out or remove the fetch logic
|
|||||||
|
|
||||||
#### Image Generation Prompts
|
#### Image Generation Prompts
|
||||||
|
|
||||||
Customize the mascot generation prompt in `src/classes/ai.ts:95-97`:
|
Customise the mascot generation prompt in `src/classes/ai.ts:95-97`:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
systemInstruction: `Your custom prompt here`
|
systemInstruction: `Your custom prompt here`
|
||||||
@@ -261,7 +261,7 @@ Adjust the aspect ratio in `src/classes/ai.ts:95`:
|
|||||||
imageConfig: { aspectRatio: "3:4" } // Options: "1:1", "16:9", "9:16", etc.
|
imageConfig: { aspectRatio: "3:4" } // Options: "1:1", "16:9", "9:16", etc.
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.7 Running the Application
|
### 2.7. Running the Application
|
||||||
|
|
||||||
**Development Mode:**
|
**Development Mode:**
|
||||||
```bash
|
```bash
|
||||||
@@ -285,7 +285,7 @@ If you're not using 1Password for secret management, modify the `start` script i
|
|||||||
|
|
||||||
Then ensure your environment variables are loaded through your preferred method (e.g., dotenv, system environment variables).
|
Then ensure your environment variables are loaded through your preferred method (e.g., dotenv, system environment variables).
|
||||||
|
|
||||||
### 2.8 Development Workflow
|
### 2.8. Development Workflow
|
||||||
|
|
||||||
**Code Linting:**
|
**Code Linting:**
|
||||||
```bash
|
```bash
|
||||||
@@ -308,7 +308,7 @@ pnpm test
|
|||||||
|
|
||||||
Note: Currently no tests are implemented. This command returns successfully with exit code 0.
|
Note: Currently no tests are implemented. This command returns successfully with exit code 0.
|
||||||
|
|
||||||
### 2.9 Project Structure
|
### 2.9. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
nomena/
|
nomena/
|
||||||
@@ -331,7 +331,7 @@ nomena/
|
|||||||
└── TERMS.md # Terms of service
|
└── TERMS.md # Terms of service
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.10 Logging and Monitoring
|
### 2.10. Logging and Monitoring
|
||||||
|
|
||||||
The Application uses @nhcarrigan/logger for logging with Discord Analytics integration. Logs include:
|
The Application uses @nhcarrigan/logger for logging with Discord Analytics integration. Logs include:
|
||||||
|
|
||||||
@@ -339,13 +339,13 @@ The Application uses @nhcarrigan/logger for logging with Discord Analytics integ
|
|||||||
- Error tracking (when enabled in the logger)
|
- Error tracking (when enabled in the logger)
|
||||||
- Custom analytics events (when configured)
|
- Custom analytics events (when configured)
|
||||||
|
|
||||||
To modify logging behavior, update the logger initialization in `src/index.ts:21`:
|
To modify logging behaviour, update the logger initialization in `src/index.ts:21`:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const logger = new Logger("Nomena", process.env.LOG_TOKEN);
|
const logger = new Logger("Nomena", process.env.LOG_TOKEN);
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.11 Troubleshooting
|
### 2.11. Troubleshooting
|
||||||
|
|
||||||
**Bot doesn't respond:**
|
**Bot doesn't respond:**
|
||||||
- Verify the bot has the Message Content intent enabled
|
- Verify the bot has the Message Content intent enabled
|
||||||
@@ -370,7 +370,7 @@ const logger = new Logger("Nomena", process.env.LOG_TOKEN);
|
|||||||
- Verify bot permissions in Discord server settings
|
- Verify bot permissions in Discord server settings
|
||||||
- Ensure the bot role has sufficient privileges
|
- Ensure the bot role has sufficient privileges
|
||||||
|
|
||||||
### 2.12 Production Deployment
|
### 2.12. Production Deployment
|
||||||
|
|
||||||
**Recommended Setup:**
|
**Recommended Setup:**
|
||||||
- Use a process manager (PM2, systemd, Docker)
|
- Use a process manager (PM2, systemd, Docker)
|
||||||
@@ -409,7 +409,7 @@ RUN pnpm run build
|
|||||||
CMD ["node", "prod/index.js"]
|
CMD ["node", "prod/index.js"]
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.13 API Rate Limits and Costs
|
### 2.13. API Rate Limits and Costs
|
||||||
|
|
||||||
**Anthropic (Claude AI):**
|
**Anthropic (Claude AI):**
|
||||||
- Free tier: Limited requests per month
|
- Free tier: Limited requests per month
|
||||||
@@ -432,14 +432,14 @@ Monitor your usage to avoid unexpected costs or service interruptions.
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
This Application is licensed under Naomi's Public License. The full license text is available at:
|
This Application is licensed under Naomi's Public Licence. The full licence text is available at:
|
||||||
https://docs.nhcarrigan.com/#/license
|
https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
### 3.2 Privacy Policy
|
### 3.2. Privacy Policy
|
||||||
|
|
||||||
The Application's privacy practices are governed by the global privacy policy available at:
|
The Application's privacy practices are governed by the global privacy policy available at:
|
||||||
https://docs.nhcarrigan.com/#/privacy
|
https://docs.nhcarrigan.com/#/privacy
|
||||||
@@ -464,14 +464,14 @@ https://docs.nhcarrigan.com/#/privacy
|
|||||||
|
|
||||||
Users should review the privacy policies of these third-party services.
|
Users should review the privacy policies of these third-party services.
|
||||||
|
|
||||||
### 3.3 Security Policy
|
### 3.3. Security Policy
|
||||||
|
|
||||||
The Application's security practices follow the global security policy available at:
|
The Application's security practices follow the global security policy available at:
|
||||||
https://docs.nhcarrigan.com/#/security
|
https://docs.nhcarrigan.com/#/security
|
||||||
|
|
||||||
**Application-Specific Security Measures:**
|
**Application-Specific Security Measures:**
|
||||||
|
|
||||||
- **Access Control**: User ID verification limits bot usage to authorized individuals
|
- **Access Control**: User ID verification limits bot usage to authorised individuals
|
||||||
- **Environment Variables**: Sensitive API keys are stored in environment variables, not in code
|
- **Environment Variables**: Sensitive API keys are stored in environment variables, not in code
|
||||||
- **Input Validation**: User input is sanitized before being sent to AI APIs
|
- **Input Validation**: User input is sanitized before being sent to AI APIs
|
||||||
- **Error Handling**: Errors are caught and handled gracefully without exposing sensitive information
|
- **Error Handling**: Errors are caught and handled gracefully without exposing sensitive information
|
||||||
@@ -490,7 +490,7 @@ https://docs.nhcarrigan.com/#/security
|
|||||||
If you discover a security vulnerability, please report it following the guidelines at:
|
If you discover a security vulnerability, please report it following the guidelines at:
|
||||||
https://docs.nhcarrigan.com/#/security
|
https://docs.nhcarrigan.com/#/security
|
||||||
|
|
||||||
### 3.4 Terms of Service
|
### 3.4. Terms of Service
|
||||||
|
|
||||||
General terms of service can be found in the `TERMS.md` file in the repository.
|
General terms of service can be found in the `TERMS.md` file in the repository.
|
||||||
|
|
||||||
@@ -502,7 +502,7 @@ General terms of service can be found in the `TERMS.md` file in the repository.
|
|||||||
- The Application makes best efforts to generate unique names but does not guarantee uniqueness outside of the internal project database
|
- The Application makes best efforts to generate unique names but does not guarantee uniqueness outside of the internal project database
|
||||||
- Generated images are created by AI and may not always match expectations or requirements
|
- Generated images are created by AI and may not always match expectations or requirements
|
||||||
|
|
||||||
### 3.5 Content Policy
|
### 3.5. Content Policy
|
||||||
|
|
||||||
**Generated Content:**
|
**Generated Content:**
|
||||||
- AI-generated names and images are provided "as-is"
|
- AI-generated names and images are provided "as-is"
|
||||||
@@ -514,7 +514,7 @@ General terms of service can be found in the `TERMS.md` file in the repository.
|
|||||||
- The system prompt instructs the AI to create appropriate content
|
- The system prompt instructs the AI to create appropriate content
|
||||||
- Image generation may fail if content policies are violated
|
- Image generation may fail if content policies are violated
|
||||||
|
|
||||||
### 3.6 Code of Conduct
|
### 3.6. Code of Conduct
|
||||||
|
|
||||||
Contributors and users are expected to follow the code of conduct available at:
|
Contributors and users are expected to follow the code of conduct available at:
|
||||||
https://docs.nhcarrigan.com/#/coc
|
https://docs.nhcarrigan.com/#/coc
|
||||||
@@ -523,14 +523,14 @@ https://docs.nhcarrigan.com/#/coc
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 General Contributing Guidelines
|
### 4.1. General Contributing Guidelines
|
||||||
|
|
||||||
General contributing guidelines can be found at:
|
General contributing guidelines can be found at:
|
||||||
https://docs.nhcarrigan.com/#/contributing
|
https://docs.nhcarrigan.com/#/contributing
|
||||||
|
|
||||||
Please review these guidelines before contributing to the Application.
|
Please review these guidelines before contributing to the Application.
|
||||||
|
|
||||||
### 4.2 Development Setup
|
### 4.2. Development Setup
|
||||||
|
|
||||||
Follow the installation instructions in Section 2.3 (Installation) to set up your development environment.
|
Follow the installation instructions in Section 2.3 (Installation) to set up your development environment.
|
||||||
|
|
||||||
@@ -540,7 +540,7 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
- **TypeScript**: Strong typing is enforced throughout the codebase
|
- **TypeScript**: Strong typing is enforced throughout the codebase
|
||||||
- **Code Style**: Follow the existing code style and conventions
|
- **Code Style**: Follow the existing code style and conventions
|
||||||
|
|
||||||
### 4.3 Code Quality Standards
|
### 4.3. Code Quality Standards
|
||||||
|
|
||||||
**Linting:**
|
**Linting:**
|
||||||
- All code must pass `pnpm run lint` without warnings
|
- All code must pass `pnpm run lint` without warnings
|
||||||
@@ -560,12 +560,12 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright NHCarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.4 Contribution Workflow
|
### 4.4. Contribution Workflow
|
||||||
|
|
||||||
1. **Fork the repository**
|
1. **Fork the repository**
|
||||||
2. **Create a feature branch**: `git checkout -b feature/your-feature-name`
|
2. **Create a feature branch**: `git checkout -b feature/your-feature-name`
|
||||||
@@ -576,7 +576,7 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
7. **Push to your fork**: `git push origin feature/your-feature-name`
|
7. **Push to your fork**: `git push origin feature/your-feature-name`
|
||||||
8. **Open a pull request**
|
8. **Open a pull request**
|
||||||
|
|
||||||
### 4.5 Pull Request Guidelines
|
### 4.5. Pull Request Guidelines
|
||||||
|
|
||||||
**Before Submitting:**
|
**Before Submitting:**
|
||||||
- Ensure all code passes linting
|
- Ensure all code passes linting
|
||||||
@@ -591,19 +591,19 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
- Testing performed
|
- Testing performed
|
||||||
- Screenshots (for UI changes, if applicable)
|
- Screenshots (for UI changes, if applicable)
|
||||||
|
|
||||||
### 4.6 Areas for Contribution
|
### 4.6. Areas for Contribution
|
||||||
|
|
||||||
**Feature Enhancements:**
|
**Feature Enhancements:**
|
||||||
- Multi-user support improvements
|
- Multi-user support improvements
|
||||||
- Additional AI model options
|
- Additional AI model options
|
||||||
- Customizable response formats
|
- Customizable response formats
|
||||||
- Project name filtering options
|
- Project name filtering options
|
||||||
- Image style customization
|
- Image style customisation
|
||||||
|
|
||||||
**Code Quality:**
|
**Code Quality:**
|
||||||
- Adding unit tests
|
- Adding unit tests
|
||||||
- Improving error handling
|
- Improving error handling
|
||||||
- Performance optimizations
|
- Performance optimisations
|
||||||
- Code documentation
|
- Code documentation
|
||||||
|
|
||||||
**Bug Fixes:**
|
**Bug Fixes:**
|
||||||
@@ -617,7 +617,7 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
- Improving setup instructions
|
- Improving setup instructions
|
||||||
- Creating video tutorials
|
- Creating video tutorials
|
||||||
|
|
||||||
### 4.7 Testing Guidelines
|
### 4.7. Testing Guidelines
|
||||||
|
|
||||||
**Currently, the Application has no automated tests.** Contributors are encouraged to:
|
**Currently, the Application has no automated tests.** Contributors are encouraged to:
|
||||||
|
|
||||||
@@ -630,7 +630,7 @@ Follow the installation instructions in Section 2.3 (Installation) to set up you
|
|||||||
- Jest for unit testing
|
- Jest for unit testing
|
||||||
- Discord.js test utilities for bot testing
|
- Discord.js test utilities for bot testing
|
||||||
|
|
||||||
### 4.8 Commit Message Format
|
### 4.8. Commit Message Format
|
||||||
|
|
||||||
Follow conventional commit format:
|
Follow conventional commit format:
|
||||||
|
|
||||||
@@ -660,14 +660,14 @@ docs(readme): update installation instructions
|
|||||||
fix(bot): handle missing image generation gracefully
|
fix(bot): handle missing image generation gracefully
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.9 Review Process
|
### 4.9. Review Process
|
||||||
|
|
||||||
- Pull requests will be reviewed by project maintainers
|
- Pull requests will be reviewed by project maintainers
|
||||||
- Feedback may be provided for changes or improvements
|
- Feedback may be provided for changes or improvements
|
||||||
- Once approved, PRs will be merged by maintainers
|
- Once approved, PRs will be merged by maintainers
|
||||||
- Contributors will be credited in release notes
|
- Contributors will be credited in release notes
|
||||||
|
|
||||||
### 4.10 Getting Help
|
### 4.10. Getting Help
|
||||||
|
|
||||||
If you need help contributing:
|
If you need help contributing:
|
||||||
|
|
||||||
@@ -676,7 +676,7 @@ If you need help contributing:
|
|||||||
- Open a discussion in the repository
|
- Open a discussion in the repository
|
||||||
- Reach out to maintainers
|
- Reach out to maintainers
|
||||||
|
|
||||||
### 4.11 Code Organization
|
### 4.11. Code Organization
|
||||||
|
|
||||||
When adding new features, follow the existing structure:
|
When adding new features, follow the existing structure:
|
||||||
|
|
||||||
@@ -694,7 +694,7 @@ src/
|
|||||||
- Use dependency injection where appropriate
|
- Use dependency injection where appropriate
|
||||||
- Avoid tight coupling between components
|
- Avoid tight coupling between components
|
||||||
|
|
||||||
### 4.12 Dependencies
|
### 4.12. Dependencies
|
||||||
|
|
||||||
**Adding Dependencies:**
|
**Adding Dependencies:**
|
||||||
- Prefer well-maintained packages with active communities
|
- Prefer well-maintained packages with active communities
|
||||||
@@ -763,7 +763,7 @@ A: Yes, the bot can run on services like Heroku (legacy), Railway, Render, or Fl
|
|||||||
### D. Credits
|
### D. Credits
|
||||||
|
|
||||||
- **Author**: Naomi Carrigan
|
- **Author**: Naomi Carrigan
|
||||||
- **License**: Naomi's Public License
|
- **License**: Naomi's Public Licence
|
||||||
- **Dependencies**: See package.json for full list
|
- **Dependencies**: See package.json for full list
|
||||||
- **Special Thanks**: Anthropic, Google, and Discord.js contributors
|
- **Special Thanks**: Anthropic, Google, and Discord.js contributors
|
||||||
|
|
||||||
@@ -777,5 +777,4 @@ A: Yes, the bot can run on services like Heroku (legacy), Railway, Render, or Fl
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: 2025-10-31
|
|
||||||
**Documentation Version**: 1.0.0
|
**Documentation Version**: 1.0.0
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ Required environment variables:
|
|||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### License
|
### License
|
||||||
This software is licensed under Naomi's Public License as specified in the source code headers.
|
This software is licensed under Naomi's Public Licence as specified in the source code headers.
|
||||||
|
|
||||||
### Data Collection
|
### Data Collection
|
||||||
The Application collects and stores:
|
The Application collects and stores:
|
||||||
@@ -141,7 +141,7 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
|
|
||||||
### Code Style Guidelines
|
### Code Style Guidelines
|
||||||
|
|
||||||
- **Licensing**: All files must include copyright header with Naomi's Public License
|
- **Licensing**: All files must include copyright header with Naomi's Public Licence
|
||||||
- **Comments**: Minimal commenting (code should be self-documenting)
|
- **Comments**: Minimal commenting (code should be self-documenting)
|
||||||
- **TypeScript**: Strict typing with explicit interfaces
|
- **TypeScript**: Strict typing with explicit interfaces
|
||||||
- **ESLint**: Zero warnings policy enforced in CI
|
- **ESLint**: Zero warnings policy enforced in CI
|
||||||
@@ -150,7 +150,7 @@ This section is for documentation related to contributing to the Application's c
|
|||||||
### Architecture Patterns
|
### Architecture Patterns
|
||||||
|
|
||||||
- **Command Pattern**: Each slash command in separate file with common interface
|
- **Command Pattern**: Each slash command in separate file with common interface
|
||||||
- **Error Handling**: Centralized error handler with UUID tracking
|
- **Error Handling**: Centralised error handler with UUID tracking
|
||||||
- **Type Safety**: Comprehensive TypeScript interfaces and type guards
|
- **Type Safety**: Comprehensive TypeScript interfaces and type guards
|
||||||
- **Separation of Concerns**: Clear module boundaries (commands, modules, utils, config)
|
- **Separation of Concerns**: Clear module boundaries (commands, modules, utils, config)
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Portfolio
|
title: Portfolio
|
||||||
---
|
---
|
||||||
Portfolio (hereinafter the "Application") is a static HTML landing page that serves as the primary web presence for NHCarrigan, a software engineering and community management consulting firm. The Application provides information about the organization's services, contact methods, past clients, and founder, while serving as a gateway to the broader NHCarrigan ecosystem of tools and communities.
|
Portfolio (hereinafter the "Application") is a static HTML landing page that serves as the primary web presence for NHCarrigan, a software engineering and community management consulting firm. The Application provides information about the organisation's services, contact methods, past clients, and founder, while serving as a gateway to the broader NHCarrigan ecosystem of tools and communities.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -13,16 +13,15 @@ The Application is currently deployed and accessible at [nhcarrigan.com](https:/
|
|||||||
|
|
||||||
### Available Features
|
### Available Features
|
||||||
|
|
||||||
- **Company Information**: Overview of NHCarrigan's consulting services specializing in community management and software engineering
|
- **Company Information**: Overview of NHCarrigan's consulting services specialising in community management and software engineering
|
||||||
- **Service Offerings**: Details about tools and infrastructure development for online community management
|
- **Service Offerings**: Details about tools and infrastructure development for online community management
|
||||||
- **Contact Options**: Multiple ways to reach the organization including:
|
- **Contact Options**: Multiple ways to reach the organisation including:
|
||||||
- Public Discord community
|
- Public Discord community
|
||||||
- Forum for long-form discussions
|
|
||||||
- Commission inquiry form
|
- Commission inquiry form
|
||||||
- General contact form
|
- General contact form
|
||||||
- Paid meeting scheduling
|
- Paid meeting scheduling
|
||||||
- **Past Work**: Links to founder's resume, client testimonials, sitemap, and open source code
|
- **Past Work**: Links to founder's resume, client testimonials, sitemap, and open source code
|
||||||
- **Founder Information**: Background about Naomi Carrigan and the organization's mission
|
- **Founder Information**: Background about Naomi Carrigan and the organisation's mission
|
||||||
- **Resource Links**: Access to documentation, policies, and educational content
|
- **Resource Links**: Access to documentation, policies, and educational content
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
@@ -54,7 +53,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
### Current Legal Framework
|
### Current Legal Framework
|
||||||
|
|
||||||
The Application operates under NHCarrigan's standard legal documentation:
|
The Application operates under NHCarrigan's standard legal documentation:
|
||||||
- **License**: Global software license (available at docs.nhcarrigan.com)
|
- **License**: Global software licence (available at docs.nhcarrigan.com)
|
||||||
- **Copyright**: Held by Naomi Carrigan
|
- **Copyright**: Held by Naomi Carrigan
|
||||||
- **Code of Conduct**: Available in repository and at docs.nhcarrigan.com
|
- **Code of Conduct**: Available in repository and at docs.nhcarrigan.com
|
||||||
- **Privacy Policy**: Referenced on the website
|
- **Privacy Policy**: Referenced on the website
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Resume
|
title: Resume
|
||||||
---
|
---
|
||||||
|
|
||||||
Resume (hereinafter the "Application") is a static site generator that transforms a YAML or JSON resume source into a styled HTML resume website, along with downloadable formats. It is designed for easy customization and deployment, using TypeScript for parsing and rendering, and outputs a ready-to-host static site.
|
Resume (hereinafter the "Application") is a static site generator that transforms a YAML or JSON resume source into a styled HTML resume website, along with downloadable formats. It is designed for easy customisation and deployment, using TypeScript for parsing and rendering, and outputs a ready-to-host static site.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@ The Application generates a professional, accessible resume website from structu
|
|||||||
|
|
||||||
### Features
|
### Features
|
||||||
- **Responsive Design**: Mobile-friendly layout that works on all devices
|
- **Responsive Design**: Mobile-friendly layout that works on all devices
|
||||||
- **Print-Optimized**: Print or save as PDF with optimized styling
|
- **Print-Optimized**: Print or save as PDF with optimised styling
|
||||||
- **Multiple Formats**: Download resume data in YAML or JSON format
|
- **Multiple Formats**: Download resume data in YAML or JSON format
|
||||||
- **Professional Sections**: Employment, volunteer work, education, certifications, projects, and publications
|
- **Professional Sections**: Employment, volunteer work, education, certifications, projects, and publications
|
||||||
- **Navigation Links**: Quick jump links to different resume sections
|
- **Navigation Links**: Quick jump links to different resume sections
|
||||||
@@ -19,7 +19,7 @@ The Application generates a professional, accessible resume website from structu
|
|||||||
### Using the Resume Website
|
### Using the Resume Website
|
||||||
1. **Browse Sections**: Use the navigation links to jump to specific sections (Employment, Education, etc.)
|
1. **Browse Sections**: Use the navigation links to jump to specific sections (Employment, Education, etc.)
|
||||||
2. **Download Data**: Click "YAML" or "JSON" links to download the resume in structured formats
|
2. **Download Data**: Click "YAML" or "JSON" links to download the resume in structured formats
|
||||||
3. **Print/Save PDF**: Click the "print" link to open browser print dialog for PDF saving
|
3. **Print/Save PDF**: Click the "print" link to open browser print dialogue for PDF saving
|
||||||
4. **Contact**: Use the "submit your own request" link to contact for opportunities
|
4. **Contact**: Use the "submit your own request" link to contact for opportunities
|
||||||
|
|
||||||
### Resume Sections
|
### Resume Sections
|
||||||
@@ -79,7 +79,7 @@ The resume data follows this schema:
|
|||||||
|
|
||||||
### Customization
|
### Customization
|
||||||
1. **Content**: Edit `src/source.yaml` with your resume data
|
1. **Content**: Edit `src/source.yaml` with your resume data
|
||||||
2. **Styling**: Modify `src/static/style.css` for visual customization
|
2. **Styling**: Modify `src/static/style.css` for visual customisation
|
||||||
3. **Structure**: Update `src/parse.ts` to change HTML generation
|
3. **Structure**: Update `src/parse.ts` to change HTML generation
|
||||||
4. **Types**: Extend `src/interfaces/resume.ts` for new data fields
|
4. **Types**: Extend `src/interfaces/resume.ts` for new data fields
|
||||||
|
|
||||||
@@ -96,10 +96,10 @@ Deploy to any static hosting service (Netlify, Vercel, GitHub Pages, etc.)
|
|||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
### License
|
### License
|
||||||
This software is licensed under Naomi's Public License. Copyright held by Naomi Carrigan.
|
This software is licensed under Naomi's Public Licence. Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
For complete legal terms, refer to:
|
For complete legal terms, refer to:
|
||||||
- [Global Software License](https://docs.nhcarrigan.com/#/license)
|
- [Global Software Licence](https://docs.nhcarrigan.com/#/license)
|
||||||
- [LICENSE.md](LICENSE.md) in the repository
|
- [LICENSE.md](LICENSE.md) in the repository
|
||||||
- [PRIVACY.md](PRIVACY.md) for privacy policy
|
- [PRIVACY.md](PRIVACY.md) for privacy policy
|
||||||
- [TERMS.md](TERMS.md) for terms of service
|
- [TERMS.md](TERMS.md) for terms of service
|
||||||
@@ -153,15 +153,15 @@ All contributions must pass:
|
|||||||
- **Build**: Successful site generation
|
- **Build**: Successful site generation
|
||||||
|
|
||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
- Use GitHub Issues for bugs and feature requests
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Provide detailed reproduction steps for bugs
|
- Provide detailed reproduction steps for bugs
|
||||||
- Include relevant error messages and logs
|
- Include relevant error messages and logs
|
||||||
- Tag issues appropriately (bug, enhancement, documentation)
|
- Tag issues appropriately (bug, enhancement, documentation)
|
||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
- [Chat Server](http://chat.nhcarrigan.com) for real-time discussion
|
- [Chat Server](https://chat.nhcarrigan.com) for real-time discussion
|
||||||
- Email: contact@nhcarrigan.com for direct communication
|
- Email: contact@nhcarrigan.com for direct communication
|
||||||
- GitHub Issues for project-specific discussions
|
- Discord forum channels (#bug-reports or #feature-requests) for project-specific discussions
|
||||||
|
|
||||||
### Project Structure
|
### Project Structure
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Rosalia Nightsong
|
title: Rosalia Nightsong
|
||||||
---
|
---
|
||||||
|
|
||||||
Rosalia Nightsong (hereinafter the "Application") is a centralized alert server that receives and forwards application logs, errors, uptime notifications, Discord entitlements, and Stripe payment events to both email and Discord channels for real-time monitoring and notification purposes.
|
Rosalia Nightsong (hereinafter the "Application") is a centralised alert server that receives and forwards application logs, errors, uptime notifications, Discord entitlements, and Stripe payment events to both email and Discord channels for real-time monitoring and notification purposes.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -141,7 +141,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. Copyright held by Naomi Carrigan.
|
This software is licensed under Naomi's Public Licence. Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
### Data Handling
|
### Data Handling
|
||||||
|
|
||||||
@@ -204,4 +204,4 @@ Currently, no automated tests are configured. Contributors are encouraged to man
|
|||||||
|
|
||||||
### Contact
|
### Contact
|
||||||
|
|
||||||
For questions or support, contact through the [Chat Server](http://chat.nhcarrigan.com) or email `contact@nhcarrigan.com`.
|
For questions or support, contact through the [Chat Server](https://chat.nhcarrigan.com) or email `contact@nhcarrigan.com`.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Saisoku
|
title: Saisoku
|
||||||
---
|
---
|
||||||
|
|
||||||
Saisoku (hereinafter the "Application") is a Discord bot designed to help users maintain productivity through hourly task reminders. The bot allows users to create reminders with either encouraging or bullying messages, providing customizable motivation styles to suit different preferences.
|
Saisoku (hereinafter the "Application") is a Discord bot designed to help users maintain productivity through hourly task reminders. The bot allows users to create reminders with either encouraging or bullying messages, providing customisable motivation styles to suit different preferences.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Adding the Bot to Discord
|
### Adding the Bot to Discord
|
||||||
|
|
||||||
To use Saisoku, add it to Discord using the [official invite link](https://discord.com/oauth2/authorize?client_id=1438325099345346723).
|
To use Saisoku, add it to Discord using the [official invite link](https://discord.com/oauth2/authorise?client_id=1438325099345346723).
|
||||||
|
|
||||||
### Subscription Requirements
|
### Subscription Requirements
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ The application uses a single MongoDB collection:
|
|||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/saisoku.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/saisoku.git
|
||||||
cd saisoku
|
cd saisoku
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -262,7 +262,7 @@ For the complete Terms of Service, please visit: https://docs.nhcarrigan.com/#/t
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. Copyright is held by Naomi Carrigan.
|
This software is licensed under Naomi's Public Licence. Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
For more information, see the LICENSE.md file in the repository.
|
For more information, see the LICENSE.md file in the repository.
|
||||||
|
|
||||||
@@ -307,7 +307,7 @@ The project uses:
|
|||||||
### Key Areas for Contribution
|
### Key Areas for Contribution
|
||||||
|
|
||||||
1. **Phrase Library** (`src/config/phrases.ts`): Add new encouraging or bullying phrases
|
1. **Phrase Library** (`src/config/phrases.ts`): Add new encouraging or bullying phrases
|
||||||
2. **Features**: Propose new reminder features or customization options
|
2. **Features**: Propose new reminder features or customisation options
|
||||||
3. **Documentation**: Improve user or technical documentation
|
3. **Documentation**: Improve user or technical documentation
|
||||||
4. **Bug Fixes**: Address issues reported in the issue tracker
|
4. **Bug Fixes**: Address issues reported in the issue tracker
|
||||||
5. **Testing**: Add test coverage (currently minimal)
|
5. **Testing**: Add test coverage (currently minimal)
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ op run --env-file=.env -- tsx src/crowdin/reapplyTranslations.ts
|
|||||||
|
|
||||||
##### Audit NPM Packages (`src/github/auditNpmPackages.ts`)
|
##### Audit NPM Packages (`src/github/auditNpmPackages.ts`)
|
||||||
|
|
||||||
Scans GitHub organization repositories for known vulnerable npm packages.
|
Scans GitHub organisation repositories for known vulnerable npm packages.
|
||||||
|
|
||||||
**Usage:**
|
**Usage:**
|
||||||
```bash
|
```bash
|
||||||
@@ -88,7 +88,7 @@ op run --env-file=.env -- tsx src/github/auditNpmPackages.ts
|
|||||||
```
|
```
|
||||||
|
|
||||||
**What it does:**
|
**What it does:**
|
||||||
- Fetches all repositories from the FreeCodeCamp GitHub organization
|
- Fetches all repositories from the FreeCodeCamp GitHub organisation
|
||||||
- Searches for 18 known vulnerable package versions in `package.json` files
|
- Searches for 18 known vulnerable package versions in `package.json` files
|
||||||
- Generates a report of vulnerable dependencies
|
- Generates a report of vulnerable dependencies
|
||||||
- Saves results to `data/npm-vulnerabilities.txt`
|
- Saves results to `data/npm-vulnerabilities.txt`
|
||||||
@@ -183,7 +183,7 @@ tsx src/music/id3v2.ts
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 System Requirements
|
### 2.1. System Requirements
|
||||||
|
|
||||||
**Runtime:**
|
**Runtime:**
|
||||||
- Node.js (compatible with v24.3.0 type definitions)
|
- Node.js (compatible with v24.3.0 type definitions)
|
||||||
@@ -197,7 +197,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
**Optional:**
|
**Optional:**
|
||||||
- 1Password CLI (`op`) for secure environment variable management
|
- 1Password CLI (`op`) for secure environment variable management
|
||||||
|
|
||||||
### 2.2 Installation
|
### 2.2. Installation
|
||||||
|
|
||||||
1. **Clone the repository:**
|
1. **Clone the repository:**
|
||||||
```bash
|
```bash
|
||||||
@@ -242,7 +242,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
pip install eyeD3
|
pip install eyeD3
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.3 Configuration
|
### 2.3. Configuration
|
||||||
|
|
||||||
**TypeScript Configuration (`tsconfig.json`):**
|
**TypeScript Configuration (`tsconfig.json`):**
|
||||||
- Extends `@nhcarrigan/typescript-config`
|
- Extends `@nhcarrigan/typescript-config`
|
||||||
@@ -261,11 +261,11 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
To adapt scripts for your use:
|
To adapt scripts for your use:
|
||||||
|
|
||||||
1. **Crowdin scripts:** Update environment variables in `.env`
|
1. **Crowdin scripts:** Update environment variables in `.env`
|
||||||
2. **GitHub audit:** Modify organization name in `src/github/auditNpmPackages.ts:48`
|
2. **GitHub audit:** Modify organisation name in `src/github/auditNpmPackages.ts:48`
|
||||||
3. **Discord threads:** Update channel ID and talk data in `src/discord/cycThreads.ts`
|
3. **Discord threads:** Update channel ID and talk data in `src/discord/cycThreads.ts`
|
||||||
4. **Media processing:** Update file paths in `src/music/id3v2.ts:7-8`
|
4. **Media processing:** Update file paths in `src/music/id3v2.ts:7-8`
|
||||||
|
|
||||||
### 2.4 Project Structure
|
### 2.4. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/
|
scripts/
|
||||||
@@ -294,7 +294,7 @@ scripts/
|
|||||||
└── eslint.config.js # Linting rules
|
└── eslint.config.js # Linting rules
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.5 Development
|
### 2.5. Development
|
||||||
|
|
||||||
**Build the project:**
|
**Build the project:**
|
||||||
```bash
|
```bash
|
||||||
@@ -316,7 +316,7 @@ pnpm build
|
|||||||
node prod/path/to/script.js
|
node prod/path/to/script.js
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.6 API Integration Details
|
### 2.6. API Integration Details
|
||||||
|
|
||||||
**Crowdin API:**
|
**Crowdin API:**
|
||||||
- Base URL: `https://api.crowdin.com/api/v2`
|
- Base URL: `https://api.crowdin.com/api/v2`
|
||||||
@@ -336,7 +336,7 @@ node prod/path/to/script.js
|
|||||||
- Rate limiting: Automatic retry with backoff on 429 responses
|
- Rate limiting: Automatic retry with backoff on 429 responses
|
||||||
- Required intents: Message content, guild messages
|
- Required intents: Message content, guild messages
|
||||||
|
|
||||||
### 2.7 Data Storage
|
### 2.7. Data Storage
|
||||||
|
|
||||||
**Generated files:**
|
**Generated files:**
|
||||||
- `data/crowdin-files.json` (~12MB) - Cached Crowdin file metadata
|
- `data/crowdin-files.json` (~12MB) - Cached Crowdin file metadata
|
||||||
@@ -349,7 +349,7 @@ node prod/path/to/script.js
|
|||||||
- GitHub audit data is generated per run
|
- GitHub audit data is generated per run
|
||||||
- Discord thread creation is one-time execution
|
- Discord thread creation is one-time execution
|
||||||
|
|
||||||
### 2.8 Security Considerations
|
### 2.8. Security Considerations
|
||||||
|
|
||||||
1. **Secrets Management:**
|
1. **Secrets Management:**
|
||||||
- Use 1Password CLI or similar tools for environment variable injection
|
- Use 1Password CLI or similar tools for environment variable injection
|
||||||
@@ -371,7 +371,7 @@ node prod/path/to/script.js
|
|||||||
- Safe JSON parsing with error handling
|
- Safe JSON parsing with error handling
|
||||||
- File existence checks before processing
|
- File existence checks before processing
|
||||||
|
|
||||||
### 2.9 Troubleshooting
|
### 2.9. Troubleshooting
|
||||||
|
|
||||||
**Common Issues:**
|
**Common Issues:**
|
||||||
|
|
||||||
@@ -401,11 +401,11 @@ node prod/path/to/script.js
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
The Application is distributed under **Naomi's Public License**. See `LICENSE.md` for full terms.
|
The Application is distributed under **Naomi's Public Licence**. See `LICENSE.md` for full terms.
|
||||||
|
|
||||||
### 3.2 Privacy Policy
|
### 3.2. Privacy Policy
|
||||||
|
|
||||||
Usage of these scripts may involve processing data from third-party services. Refer to `PRIVACY.md` for our privacy practices regarding:
|
Usage of these scripts may involve processing data from third-party services. Refer to `PRIVACY.md` for our privacy practices regarding:
|
||||||
- API credentials and tokens
|
- API credentials and tokens
|
||||||
@@ -413,7 +413,7 @@ Usage of these scripts may involve processing data from third-party services. Re
|
|||||||
- Repository metadata
|
- Repository metadata
|
||||||
- Discord message content
|
- Discord message content
|
||||||
|
|
||||||
### 3.3 Terms of Service
|
### 3.3. Terms of Service
|
||||||
|
|
||||||
By using these scripts, you agree to:
|
By using these scripts, you agree to:
|
||||||
- Comply with third-party API terms of service (Crowdin, GitHub, Discord)
|
- Comply with third-party API terms of service (Crowdin, GitHub, Discord)
|
||||||
@@ -423,7 +423,7 @@ By using these scripts, you agree to:
|
|||||||
|
|
||||||
See `TERMS.md` for complete terms.
|
See `TERMS.md` for complete terms.
|
||||||
|
|
||||||
### 3.4 Security Policy
|
### 3.4. Security Policy
|
||||||
|
|
||||||
To report security vulnerabilities in the Application itself, please refer to `SECURITY.md`.
|
To report security vulnerabilities in the Application itself, please refer to `SECURITY.md`.
|
||||||
|
|
||||||
@@ -432,7 +432,7 @@ To report security vulnerabilities in the Application itself, please refer to `S
|
|||||||
- Keep dependencies updated regularly
|
- Keep dependencies updated regularly
|
||||||
- Review `pnpm audit` output periodically
|
- Review `pnpm audit` output periodically
|
||||||
|
|
||||||
### 3.5 Data Retention
|
### 3.5. Data Retention
|
||||||
|
|
||||||
**Local Data Storage:**
|
**Local Data Storage:**
|
||||||
- Cached data in `data/` directory is stored indefinitely until manually deleted
|
- Cached data in `data/` directory is stored indefinitely until manually deleted
|
||||||
@@ -448,7 +448,7 @@ To report security vulnerabilities in the Application itself, please refer to `S
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Please refer to `CONTRIBUTING.md` for detailed contribution guidelines. Key points:
|
Please refer to `CONTRIBUTING.md` for detailed contribution guidelines. Key points:
|
||||||
|
|
||||||
@@ -467,7 +467,7 @@ Please refer to `CONTRIBUTING.md` for detailed contribution guidelines. Key poin
|
|||||||
- Verify scripts work with environment variables
|
- Verify scripts work with environment variables
|
||||||
- Test error handling and edge cases
|
- Test error handling and edge cases
|
||||||
|
|
||||||
### 4.2 Adding New Scripts
|
### 4.2. Adding New Scripts
|
||||||
|
|
||||||
To add a new automation script:
|
To add a new automation script:
|
||||||
|
|
||||||
@@ -481,7 +481,7 @@ To add a new automation script:
|
|||||||
```typescript
|
```typescript
|
||||||
/*
|
/*
|
||||||
* Copyright (C) 2025 Naomi Carrigan
|
* Copyright (C) 2025 Naomi Carrigan
|
||||||
* Licensed under Naomi's Public License
|
* Licensed under Naomi's Public Licence
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -515,7 +515,7 @@ To add a new automation script:
|
|||||||
- Verify error handling
|
- Verify error handling
|
||||||
- Check rate limit handling
|
- Check rate limit handling
|
||||||
|
|
||||||
### 4.3 Code Organization
|
### 4.3. Code Organization
|
||||||
|
|
||||||
**Shared Utilities (`src/utils/`):**
|
**Shared Utilities (`src/utils/`):**
|
||||||
Place reusable functions here:
|
Place reusable functions here:
|
||||||
@@ -536,7 +536,7 @@ Define TypeScript interfaces for:
|
|||||||
- Configuration objects
|
- Configuration objects
|
||||||
- Data models
|
- Data models
|
||||||
|
|
||||||
### 4.4 Dependency Management
|
### 4.4. Dependency Management
|
||||||
|
|
||||||
**Adding Dependencies:**
|
**Adding Dependencies:**
|
||||||
```bash
|
```bash
|
||||||
@@ -553,10 +553,10 @@ pnpm audit
|
|||||||
**Preferred Libraries:**
|
**Preferred Libraries:**
|
||||||
- API clients: Official SDKs when available (`@octokit/rest`, etc.)
|
- API clients: Official SDKs when available (`@octokit/rest`, etc.)
|
||||||
- CLI interactions: `@inquirer/prompts`
|
- CLI interactions: `@inquirer/prompts`
|
||||||
- Progress visualization: `cli-progress`
|
- Progress visualisation: `cli-progress`
|
||||||
- HTTP requests: Native `fetch` with `backoffAndRetry` wrapper
|
- HTTP requests: Native `fetch` with `backoffAndRetry` wrapper
|
||||||
|
|
||||||
### 4.5 Documentation Standards
|
### 4.5. Documentation Standards
|
||||||
|
|
||||||
**Code Comments:**
|
**Code Comments:**
|
||||||
- Use JSDoc for all exported functions
|
- Use JSDoc for all exported functions
|
||||||
@@ -587,7 +587,7 @@ export async function getFiles(projectId: string): Promise<File[]> {
|
|||||||
- Use semantic versioning principles
|
- Use semantic versioning principles
|
||||||
- Document breaking changes prominently
|
- Document breaking changes prominently
|
||||||
|
|
||||||
### 4.6 Architecture Principles
|
### 4.6. Architecture Principles
|
||||||
|
|
||||||
**Script Independence:**
|
**Script Independence:**
|
||||||
- Each script should be runnable standalone
|
- Each script should be runnable standalone
|
||||||
@@ -612,7 +612,7 @@ export async function getFiles(projectId: string): Promise<File[]> {
|
|||||||
- Use strict TypeScript configuration
|
- Use strict TypeScript configuration
|
||||||
- Validate data shapes at runtime when needed
|
- Validate data shapes at runtime when needed
|
||||||
|
|
||||||
### 4.7 Testing Approach
|
### 4.7. Testing Approach
|
||||||
|
|
||||||
While formal unit tests are not currently implemented, contributors should:
|
While formal unit tests are not currently implemented, contributors should:
|
||||||
|
|
||||||
@@ -634,7 +634,7 @@ While formal unit tests are not currently implemented, contributors should:
|
|||||||
- Set up CI/CD pipeline for automated testing
|
- Set up CI/CD pipeline for automated testing
|
||||||
- Implement test coverage reporting
|
- Implement test coverage reporting
|
||||||
|
|
||||||
### 4.8 Code of Conduct
|
### 4.8. Code of Conduct
|
||||||
|
|
||||||
All contributors must adhere to the Code of Conduct outlined in `CODE_OF_CONDUCT.md`. Key principles:
|
All contributors must adhere to the Code of Conduct outlined in `CODE_OF_CONDUCT.md`. Key principles:
|
||||||
- Be respectful and inclusive
|
- Be respectful and inclusive
|
||||||
@@ -642,7 +642,7 @@ All contributors must adhere to the Code of Conduct outlined in `CODE_OF_CONDUCT
|
|||||||
- Focus on constructive feedback
|
- Focus on constructive feedback
|
||||||
- Respect differing opinions and experiences
|
- Respect differing opinions and experiences
|
||||||
|
|
||||||
### 4.9 Getting Help
|
### 4.9. Getting Help
|
||||||
|
|
||||||
**Resources:**
|
**Resources:**
|
||||||
- Review existing scripts for examples
|
- Review existing scripts for examples
|
||||||
@@ -656,7 +656,3 @@ All contributors must adhere to the Code of Conduct outlined in `CODE_OF_CONDUCT
|
|||||||
- Follow contribution guidelines for all submissions
|
- Follow contribution guidelines for all submissions
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
**Last Updated:** 2025-10-31
|
|
||||||
**Maintained By:** Naomi Carrigan
|
|
||||||
|
|||||||
@@ -123,7 +123,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
Serenya is licensed under "Naomi's Public License" as specified in the source code headers.
|
Serenya is licensed under "Naomi's Public Licence" as specified in the source code headers.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ All source files must include the copyright header:
|
|||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright NHCarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Adding Sorielle to Your Server
|
### Adding Sorielle to Your Server
|
||||||
|
|
||||||
You can add Sorielle to your Discord server using this [invitation link](https://discord.com/oauth2/authorize?client_id=1391489982887362761).
|
You can add Sorielle to your Discord server using this [invitation link](https://discord.com/oauth2/authorise?client_id=1391489982887362761).
|
||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
@@ -31,8 +31,7 @@ You can add Sorielle to your Discord server using this [invitation link](https:/
|
|||||||
### Getting Help
|
### Getting Help
|
||||||
|
|
||||||
If you need assistance or encounter issues:
|
If you need assistance or encounter issues:
|
||||||
- Join the [Discord Server](https://chat.nhcarrigan.com)
|
- Visit our [Discord community](https://chat.nhcarrigan.com)
|
||||||
- Visit the [Forum](https://forum.nhcarrigan.com)
|
|
||||||
- Contact via email: contact@nhcarrigan.com
|
- Contact via email: contact@nhcarrigan.com
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
@@ -91,7 +90,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This software is licensed under Naomi's Public License. Full license terms are available at [docs.nhcarrigan.com](https://docs.nhcarrigan.com/#/license).
|
This software is licensed under Naomi's Public Licence. Full license terms are available at [docs.nhcarrigan.com](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
|
|
||||||
@@ -155,4 +154,4 @@ Before interacting with our community, please read our [Code of Conduct](CODE_OF
|
|||||||
|
|
||||||
For development questions or support:
|
For development questions or support:
|
||||||
- [Discord Server](https://chat.nhcarrigan.com)
|
- [Discord Server](https://chat.nhcarrigan.com)
|
||||||
- GitHub Issues for bug reports and feature requests
|
- Discord forum channels (#bug-reports or #feature-requests) for bug reports and feature requests
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ Static Pages (hereinafter the "Application") is a collection of static HTML page
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Available Pages
|
### 1.1. Available Pages
|
||||||
|
|
||||||
The Application consists of several distinct pages, each serving a specific purpose:
|
The Application consists of several distinct pages, each serving a specific purpose:
|
||||||
|
|
||||||
#### 1.1.1 Donation Page (`/donate`)
|
#### 1.1.1. Donation Page (`/donate`)
|
||||||
|
|
||||||
The donation page provides multiple avenues for supporting Naomi Carrigan's work, including:
|
The donation page provides multiple avenues for supporting Naomi Carrigan's work, including:
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ The donation page provides multiple avenues for supporting Naomi Carrigan's work
|
|||||||
- **Throne**: Gift suggestion and purchase platform
|
- **Throne**: Gift suggestion and purchase platform
|
||||||
- **Discord**: Community hub access
|
- **Discord**: Community hub access
|
||||||
|
|
||||||
#### 1.1.2 Book Library (`/books`)
|
#### 1.1.2. Book Library (`/books`)
|
||||||
|
|
||||||
An interactive explorer displaying books that Naomi has read. Features include:
|
An interactive explorer displaying books that Naomi has read. Features include:
|
||||||
|
|
||||||
@@ -37,16 +37,16 @@ An interactive explorer displaying books that Naomi has read. Features include:
|
|||||||
- JSON-backed data storage (`books.json`)
|
- JSON-backed data storage (`books.json`)
|
||||||
- Currently displays over 1,000 books
|
- Currently displays over 1,000 books
|
||||||
|
|
||||||
#### 1.1.3 Music Library (`/music`)
|
#### 1.1.3. Music Library (`/music`)
|
||||||
|
|
||||||
An interactive explorer for music that Naomi listens to. Features include:
|
An interactive explorer for music that Naomi listens to. Features include:
|
||||||
|
|
||||||
- Search functionality for artists and titles
|
- Search functionality for artists and titles
|
||||||
- Dynamic filtering with live count updates
|
- Dynamic filtering with live count updates
|
||||||
- Tabular display with alternating row colors
|
- Tabular display with alternating row colours
|
||||||
- JSON-backed data storage (`songs.json`)
|
- JSON-backed data storage (`songs.json`)
|
||||||
|
|
||||||
#### 1.1.4 Testimonials (`/testimonials`)
|
#### 1.1.4. Testimonials (`/testimonials`)
|
||||||
|
|
||||||
A comprehensive showcase of professional feedback and recommendations from:
|
A comprehensive showcase of professional feedback and recommendations from:
|
||||||
|
|
||||||
@@ -57,16 +57,16 @@ A comprehensive showcase of professional feedback and recommendations from:
|
|||||||
|
|
||||||
Features include:
|
Features include:
|
||||||
|
|
||||||
- Print-optimized styling
|
- Print-optimised styling
|
||||||
- Chronologically organized testimonials
|
- Chronologically organised testimonials
|
||||||
- Web form integration for new submissions
|
- Web form integration for new submissions
|
||||||
- Over 50 professional testimonials spanning multiple years (2023-2025)
|
- Over 50 professional testimonials spanning multiple years (2023-2025)
|
||||||
|
|
||||||
#### 1.1.5 Link Redirector (`/link-redirector`)
|
#### 1.1.5. Link Redirector (`/link-redirector`)
|
||||||
|
|
||||||
A fallback page for improperly configured subdomain redirects, providing users with support contact information.
|
A fallback page for improperly configured subdomain redirects, providing users with support contact information.
|
||||||
|
|
||||||
#### 1.1.6 Additional Pages
|
#### 1.1.6. Additional Pages
|
||||||
|
|
||||||
- **Chat** (`/chat`): Community communication hub
|
- **Chat** (`/chat`): Community communication hub
|
||||||
- **Mail** (`/mail`): Email-related services
|
- **Mail** (`/mail`): Email-related services
|
||||||
@@ -75,17 +75,17 @@ A fallback page for improperly configured subdomain redirects, providing users w
|
|||||||
- **Sitemap** (`/sitemap`): Site navigation structure
|
- **Sitemap** (`/sitemap`): Site navigation structure
|
||||||
- **Bluesky** (`/bsky`): Bluesky social platform integration
|
- **Bluesky** (`/bsky`): Bluesky social platform integration
|
||||||
|
|
||||||
### 1.2 Common Features
|
### 1.2. Common Features
|
||||||
|
|
||||||
All pages share common functionality through a global header system:
|
All pages share common functionality through a global header system:
|
||||||
|
|
||||||
- Consistent styling via CSS custom properties (variables)
|
- Consistent styling via CSS custom properties (variables)
|
||||||
- Responsive design for mobile and desktop
|
- Responsive design for mobile and desktop
|
||||||
- Global navigation (loaded from `cdn.nhcarrigan.com/headers/index.js`)
|
- Global navigation (loaded from `cdn.nhcarrigan.com/headers/index.js`)
|
||||||
- Consistent theming with foreground/background color variables
|
- Consistent theming with foreground/background colour variables
|
||||||
- Custom cursor styles
|
- Custom cursor styles
|
||||||
|
|
||||||
### 1.3 Accessibility
|
### 1.3. Accessibility
|
||||||
|
|
||||||
The Application is designed with accessibility in mind:
|
The Application is designed with accessibility in mind:
|
||||||
|
|
||||||
@@ -99,7 +99,7 @@ The Application is designed with accessibility in mind:
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Architecture
|
### 2.1. Architecture
|
||||||
|
|
||||||
The Application is a pure static website with no backend dependencies:
|
The Application is a pure static website with no backend dependencies:
|
||||||
|
|
||||||
@@ -109,7 +109,7 @@ The Application is a pure static website with no backend dependencies:
|
|||||||
- **Scripts**: Vanilla JavaScript (no frameworks)
|
- **Scripts**: Vanilla JavaScript (no frameworks)
|
||||||
- **CDN Dependencies**: Global header/navigation system from `cdn.nhcarrigan.com`
|
- **CDN Dependencies**: Global header/navigation system from `cdn.nhcarrigan.com`
|
||||||
|
|
||||||
### 2.2 File Structure
|
### 2.2. File Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
static-pages/
|
static-pages/
|
||||||
@@ -143,9 +143,9 @@ static-pages/
|
|||||||
└── CODE_OF_CONDUCT.md
|
└── CODE_OF_CONDUCT.md
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.3 Dependencies
|
### 2.3. Dependencies
|
||||||
|
|
||||||
#### 2.3.1 External Dependencies
|
#### 2.3.1. External Dependencies
|
||||||
|
|
||||||
- **Global Header System**: `https://cdn.nhcarrigan.com/headers/index.js`
|
- **Global Header System**: `https://cdn.nhcarrigan.com/headers/index.js`
|
||||||
- Provides consistent navigation and styling across all pages
|
- Provides consistent navigation and styling across all pages
|
||||||
@@ -153,21 +153,21 @@ static-pages/
|
|||||||
- **Font Awesome**: Icon library (loaded via global header)
|
- **Font Awesome**: Icon library (loaded via global header)
|
||||||
- **Custom Cursors**: `https://cdn.nhcarrigan.com/cursors/pointer.cur`
|
- **Custom Cursors**: `https://cdn.nhcarrigan.com/cursors/pointer.cur`
|
||||||
|
|
||||||
#### 2.3.2 Internal Dependencies
|
#### 2.3.2. Internal Dependencies
|
||||||
|
|
||||||
- JSON data files for dynamic content (books.json, songs.json, data.json)
|
- JSON data files for dynamic content (books.json, songs.json, data.json)
|
||||||
|
|
||||||
### 2.4 Deployment
|
### 2.4. Deployment
|
||||||
|
|
||||||
The Application can be deployed to any static web host:
|
The Application can be deployed to any static web host:
|
||||||
|
|
||||||
#### 2.4.1 Prerequisites
|
#### 2.4.1. Prerequisites
|
||||||
|
|
||||||
- Web server capable of serving static files (Nginx, Apache, etc.)
|
- Web server capable of serving static files (Nginx, Apache, etc.)
|
||||||
- No server-side processing required
|
- No server-side processing required
|
||||||
- No database required
|
- No database required
|
||||||
|
|
||||||
#### 2.4.2 Installation Steps
|
#### 2.4.2. Installation Steps
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ The Application can be deployed to any static web host:
|
|||||||
- Replace `cdn.nhcarrigan.com/headers/index.js` with your own header script
|
- Replace `cdn.nhcarrigan.com/headers/index.js` with your own header script
|
||||||
- Update custom cursor URLs if needed
|
- Update custom cursor URLs if needed
|
||||||
|
|
||||||
#### 2.4.3 Web Server Configuration
|
#### 2.4.3. Web Server Configuration
|
||||||
|
|
||||||
**Nginx Example:**
|
**Nginx Example:**
|
||||||
|
|
||||||
@@ -217,36 +217,36 @@ Options -Indexes
|
|||||||
</Files>
|
</Files>
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.5 Data Management
|
### 2.5. Data Management
|
||||||
|
|
||||||
#### 2.5.1 Books Library
|
#### 2.5.1. Books Library
|
||||||
|
|
||||||
Run `./books.sh` to update the book data. You may need to change the filepath the script reads from.
|
Run `./books.sh` to update the book data. You may need to change the filepath the script reads from.
|
||||||
|
|
||||||
#### 2.5.2 Music Library
|
#### 2.5.2. Music Library
|
||||||
|
|
||||||
Run `./songs.sh` to update the music data. You may need to change the filepath the script reads from.
|
Run `./songs.sh` to update the music data. You may need to change the filepath the script reads from.
|
||||||
|
|
||||||
#### 2.5.3 Testimonials List
|
#### 2.5.3. Testimonials List
|
||||||
|
|
||||||
Run `./testimonials.sh` to update the testimonial data from our API.
|
Run `./testimonials.sh` to update the testimonial data from our API.
|
||||||
|
|
||||||
### 2.6 Customization
|
### 2.6. Customization
|
||||||
|
|
||||||
#### 2.6.1 Styling
|
#### 2.6.1. Styling
|
||||||
|
|
||||||
Each page uses CSS custom properties that can be overridden:
|
Each page uses CSS custom properties that can be overridden:
|
||||||
|
|
||||||
- `--foreground`: Primary foreground color
|
- `--foreground`: Primary foreground colour
|
||||||
- `--background`: Primary background color
|
- `--background`: Primary background colour
|
||||||
|
|
||||||
Global styles are loaded from the CDN header system. To customize:
|
Global styles are loaded from the CDN header system. To customise:
|
||||||
|
|
||||||
1. Fork and host your own version of the header script
|
1. Fork and host your own version of the header script
|
||||||
2. Update the script src in each HTML file
|
2. Update the script src in each HTML file
|
||||||
3. Modify CSS custom properties in your hosted version
|
3. Modify CSS custom properties in your hosted version
|
||||||
|
|
||||||
#### 2.6.2 Adding New Pages
|
#### 2.6.2. Adding New Pages
|
||||||
|
|
||||||
1. Create a new directory in the root
|
1. Create a new directory in the root
|
||||||
2. Add an `index.html` file
|
2. Add an `index.html` file
|
||||||
@@ -260,7 +260,7 @@ Global styles are loaded from the CDN header system. To customize:
|
|||||||
```
|
```
|
||||||
4. Follow the existing HTML structure for consistency
|
4. Follow the existing HTML structure for consistency
|
||||||
|
|
||||||
### 2.7 System Requirements
|
### 2.7. System Requirements
|
||||||
|
|
||||||
**Client-Side:**
|
**Client-Side:**
|
||||||
|
|
||||||
@@ -274,7 +274,7 @@ Global styles are loaded from the CDN header system. To customize:
|
|||||||
- No specific server-side language requirements
|
- No specific server-side language requirements
|
||||||
- No database requirements
|
- No database requirements
|
||||||
|
|
||||||
### 2.8 Version Control
|
### 2.8. Version Control
|
||||||
|
|
||||||
The Application is managed using Git:
|
The Application is managed using Git:
|
||||||
|
|
||||||
@@ -282,7 +282,7 @@ The Application is managed using Git:
|
|||||||
- GitHub integration available
|
- GitHub integration available
|
||||||
- Standard Git workflows supported
|
- Standard Git workflows supported
|
||||||
|
|
||||||
### 2.9 Continuous Integration
|
### 2.9. Continuous Integration
|
||||||
|
|
||||||
CI/CD configuration files are located in `.gitea/workflows/`:
|
CI/CD configuration files are located in `.gitea/workflows/`:
|
||||||
|
|
||||||
@@ -292,15 +292,15 @@ CI/CD configuration files are located in `.gitea/workflows/`:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
The Application is licensed under the global software license maintained by Naomi Carrigan. Full license details are available at:
|
The Application is licensed under the global software licence maintained by Naomi Carrigan. Full licence details are available at:
|
||||||
|
|
||||||
- **URL**: https://docs.nhcarrigan.com/#/license
|
- **URL**: https://docs.nhcarrigan.com/#/license
|
||||||
- **Copyright**: All rights reserved by Naomi Carrigan
|
- **Copyright**: All rights reserved by Naomi Carrigan
|
||||||
- **Reference**: See `LICENSE.md` in the repository root
|
- **Reference**: See `LICENSE.md` in the repository root
|
||||||
|
|
||||||
### 3.2 Privacy Policy
|
### 3.2. Privacy Policy
|
||||||
|
|
||||||
User privacy is governed by the global privacy policy:
|
User privacy is governed by the global privacy policy:
|
||||||
|
|
||||||
@@ -308,25 +308,25 @@ User privacy is governed by the global privacy policy:
|
|||||||
- **Reference**: See `PRIVACY.md` in the repository root
|
- **Reference**: See `PRIVACY.md` in the repository root
|
||||||
- **Data Collection**: The Application itself does not collect user data; however, external links may have their own privacy policies
|
- **Data Collection**: The Application itself does not collect user data; however, external links may have their own privacy policies
|
||||||
|
|
||||||
### 3.3 Terms of Service
|
### 3.3. Terms of Service
|
||||||
|
|
||||||
Usage of the Application is subject to the global terms of service:
|
Usage of the Application is subject to the global terms of service:
|
||||||
|
|
||||||
- **URL**: https://docs.nhcarrigan.com/#/terms
|
- **URL**: https://docs.nhcarrigan.com/#/terms
|
||||||
- **Reference**: See `TERMS.md` in the repository root
|
- **Reference**: See `TERMS.md` in the repository root
|
||||||
|
|
||||||
### 3.4 Security Policy
|
### 3.4. Security Policy
|
||||||
|
|
||||||
Security-related information and vulnerability reporting:
|
Security-related information and vulnerability reporting:
|
||||||
|
|
||||||
- **Reference**: See `SECURITY.md` in the repository root
|
- **Reference**: See `SECURITY.md` in the repository root
|
||||||
- **Contact**: For security concerns, contact via the official channels listed in the security policy
|
- **Contact**: For security concerns, contact via the official channels listed in the security policy
|
||||||
|
|
||||||
### 3.5 Third-Party Services
|
### 3.5. Third-Party Services
|
||||||
|
|
||||||
The Application integrates with several third-party services:
|
The Application integrates with several third-party services:
|
||||||
|
|
||||||
#### 3.5.1 Donation Platforms
|
#### 3.5.1. Donation Platforms
|
||||||
|
|
||||||
- OpenCollective
|
- OpenCollective
|
||||||
- Patreon
|
- Patreon
|
||||||
@@ -341,13 +341,13 @@ The Application integrates with several third-party services:
|
|||||||
|
|
||||||
Each platform has its own terms of service and privacy policy that users should review before proceeding with transactions.
|
Each platform has its own terms of service and privacy policy that users should review before proceeding with transactions.
|
||||||
|
|
||||||
#### 3.5.2 Content Delivery Network (CDN)
|
#### 3.5.2. Content Delivery Network (CDN)
|
||||||
|
|
||||||
- **Service**: cdn.nhcarrigan.com
|
- **Service**: cdn.nhcarrigan.com
|
||||||
- **Purpose**: Global header, navigation, and styling
|
- **Purpose**: Global header, navigation, and styling
|
||||||
- **Data Handling**: Standard CDN caching and delivery
|
- **Data Handling**: Standard CDN caching and delivery
|
||||||
|
|
||||||
### 3.6 User Responsibilities
|
### 3.6. User Responsibilities
|
||||||
|
|
||||||
Users of the Application agree to:
|
Users of the Application agree to:
|
||||||
|
|
||||||
@@ -356,7 +356,7 @@ Users of the Application agree to:
|
|||||||
- Not attempt to exploit, hack, or compromise the Application's security
|
- Not attempt to exploit, hack, or compromise the Application's security
|
||||||
- Follow the Code of Conduct when interacting with the community
|
- Follow the Code of Conduct when interacting with the community
|
||||||
|
|
||||||
### 3.7 Data Portability
|
### 3.7. Data Portability
|
||||||
|
|
||||||
All user-facing data in the Application is stored in JSON format and can be easily exported or migrated:
|
All user-facing data in the Application is stored in JSON format and can be easily exported or migrated:
|
||||||
|
|
||||||
@@ -368,7 +368,7 @@ All user-facing data in the Application is stored in JSON format and can be easi
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Getting Started
|
### 4.1. Getting Started
|
||||||
|
|
||||||
To contribute to the Application:
|
To contribute to the Application:
|
||||||
|
|
||||||
@@ -393,7 +393,7 @@ To contribute to the Application:
|
|||||||
# Use any text editor or IDE
|
# Use any text editor or IDE
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.2 Contribution Workflow
|
### 4.2. Contribution Workflow
|
||||||
|
|
||||||
1. **Fork the Repository**:
|
1. **Fork the Repository**:
|
||||||
|
|
||||||
@@ -430,9 +430,9 @@ To contribute to the Application:
|
|||||||
- Click "New Pull Request"
|
- Click "New Pull Request"
|
||||||
- Fill out the pull request template in `.gitea/pull_request_template.yml`
|
- Fill out the pull request template in `.gitea/pull_request_template.yml`
|
||||||
|
|
||||||
### 4.3 Coding Standards
|
### 4.3. Coding Standards
|
||||||
|
|
||||||
#### 4.3.1 HTML Standards
|
#### 4.3.1. HTML Standards
|
||||||
|
|
||||||
- Use HTML5 semantic elements
|
- Use HTML5 semantic elements
|
||||||
- Include proper DOCTYPE declaration
|
- Include proper DOCTYPE declaration
|
||||||
@@ -440,7 +440,7 @@ To contribute to the Application:
|
|||||||
- Include viewport meta tag for responsive design
|
- Include viewport meta tag for responsive design
|
||||||
- Use descriptive page titles and meta descriptions
|
- Use descriptive page titles and meta descriptions
|
||||||
|
|
||||||
#### 4.3.2 CSS Standards
|
#### 4.3.2. CSS Standards
|
||||||
|
|
||||||
- Use CSS custom properties for theming
|
- Use CSS custom properties for theming
|
||||||
- Maintain responsive design principles
|
- Maintain responsive design principles
|
||||||
@@ -448,7 +448,7 @@ To contribute to the Application:
|
|||||||
- Include print styles where appropriate
|
- Include print styles where appropriate
|
||||||
- Test cross-browser compatibility
|
- Test cross-browser compatibility
|
||||||
|
|
||||||
#### 4.3.3 JavaScript Standards
|
#### 4.3.3. JavaScript Standards
|
||||||
|
|
||||||
- Use vanilla JavaScript (no frameworks)
|
- Use vanilla JavaScript (no frameworks)
|
||||||
- Follow ES6+ standards
|
- Follow ES6+ standards
|
||||||
@@ -457,14 +457,14 @@ To contribute to the Application:
|
|||||||
- Keep functions small and focused
|
- Keep functions small and focused
|
||||||
- Comment complex logic
|
- Comment complex logic
|
||||||
|
|
||||||
#### 4.3.4 JSON Data Standards
|
#### 4.3.4. JSON Data Standards
|
||||||
|
|
||||||
- Maintain consistent schema within each data file
|
- Maintain consistent schema within each data file
|
||||||
- Use proper JSON formatting (validated)
|
- Use proper JSON formatting (validated)
|
||||||
- Include all required fields
|
- Include all required fields
|
||||||
- Use descriptive keys
|
- Use descriptive keys
|
||||||
|
|
||||||
### 4.4 Testing
|
### 4.4. Testing
|
||||||
|
|
||||||
Before submitting a pull request:
|
Before submitting a pull request:
|
||||||
|
|
||||||
@@ -487,30 +487,30 @@ Before submitting a pull request:
|
|||||||
- Test in Safari (if available)
|
- Test in Safari (if available)
|
||||||
- Test in Edge
|
- Test in Edge
|
||||||
|
|
||||||
### 4.5 Issue Reporting
|
### 4.5. Issue Reporting
|
||||||
|
|
||||||
Use the issue templates in `.gitea/issue_template/`:
|
Post in the appropriate Discord forum channel (#bug-reports or #feature-requests) with:
|
||||||
|
|
||||||
#### 4.5.1 Bug Reports
|
#### 4.5.1. Bug Reports
|
||||||
|
|
||||||
- Template: `bug_report.yaml`
|
- Template: `bug_report.yaml`
|
||||||
- Include reproduction steps
|
- Include reproduction steps
|
||||||
- Provide browser and OS information
|
- Provide browser and OS information
|
||||||
- Include screenshots if applicable
|
- Include screenshots if applicable
|
||||||
|
|
||||||
#### 4.5.2 Feature Proposals
|
#### 4.5.2. Feature Proposals
|
||||||
|
|
||||||
- Template: `feature_proposal.yml`
|
- Template: `feature_proposal.yml`
|
||||||
- Describe the feature clearly
|
- Describe the feature clearly
|
||||||
- Explain the use case
|
- Explain the use case
|
||||||
- Consider implementation impact
|
- Consider implementation impact
|
||||||
|
|
||||||
#### 4.5.3 Other Issues
|
#### 4.5.3. Other Issues
|
||||||
|
|
||||||
- Template: `other.yml`
|
- Template: `other.yml`
|
||||||
- For general inquiries or discussions
|
- For general inquiries or discussions
|
||||||
|
|
||||||
### 4.6 Pull Request Guidelines
|
### 4.6. Pull Request Guidelines
|
||||||
|
|
||||||
- Fill out the pull request template completely
|
- Fill out the pull request template completely
|
||||||
- Reference related issues using `#issue-number`
|
- Reference related issues using `#issue-number`
|
||||||
@@ -519,44 +519,44 @@ Use the issue templates in `.gitea/issue_template/`:
|
|||||||
- Respond to review feedback promptly
|
- Respond to review feedback promptly
|
||||||
- Ensure CI checks pass (if applicable)
|
- Ensure CI checks pass (if applicable)
|
||||||
|
|
||||||
### 4.7 Communication Channels
|
### 4.7. Communication Channels
|
||||||
|
|
||||||
- **GitHub Issues**: For bug reports and feature requests
|
- **Discord Forum**: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- **Chat Server**: http://chat.nhcarrigan.com
|
- **Chat Server**: https://chat.nhcarrigan.com
|
||||||
- **Email**: contact@nhcarrigan.com
|
- **Email**: contact@nhcarrigan.com
|
||||||
- **Pull Request Discussions**: For code-specific conversations
|
- **Pull Request Discussions**: For code-specific conversations
|
||||||
|
|
||||||
### 4.8 Areas for Contribution
|
### 4.8. Areas for Contribution
|
||||||
|
|
||||||
#### 4.8.1 High Priority
|
#### 4.8.1. High Priority
|
||||||
|
|
||||||
- Accessibility improvements
|
- Accessibility improvements
|
||||||
- Cross-browser compatibility fixes
|
- Cross-browser compatibility fixes
|
||||||
- Performance optimizations
|
- Performance optimisations
|
||||||
- Documentation updates
|
- Documentation updates
|
||||||
|
|
||||||
#### 4.8.2 Medium Priority
|
#### 4.8.2. Medium Priority
|
||||||
|
|
||||||
- New page additions
|
- New page additions
|
||||||
- Enhanced filtering/search features
|
- Enhanced filtering/search features
|
||||||
- Visual design improvements
|
- Visual design improvements
|
||||||
- Mobile experience enhancements
|
- Mobile experience enhancements
|
||||||
|
|
||||||
#### 4.8.3 Low Priority
|
#### 4.8.3. Low Priority
|
||||||
|
|
||||||
- Additional data entries (books, music, etc.)
|
- Additional data entries (books, music, etc.)
|
||||||
- Minor styling tweaks
|
- Minor styling tweaks
|
||||||
- Code refactoring
|
- Code refactoring
|
||||||
|
|
||||||
### 4.9 Recognition
|
### 4.9. Recognition
|
||||||
|
|
||||||
Contributors are recognized through:
|
Contributors are recognised through:
|
||||||
|
|
||||||
- Git commit history
|
- Git commit history
|
||||||
- Pull request acknowledgments
|
- Pull request acknowledgments
|
||||||
- Potential testimonial features for significant contributions
|
- Potential testimonial features for significant contributions
|
||||||
|
|
||||||
### 4.10 Development Tools
|
### 4.10. Development Tools
|
||||||
|
|
||||||
Recommended tools for contributing:
|
Recommended tools for contributing:
|
||||||
|
|
||||||
@@ -565,7 +565,7 @@ Recommended tools for contributing:
|
|||||||
- **Validators**: W3C HTML Validator, JSONLint
|
- **Validators**: W3C HTML Validator, JSONLint
|
||||||
- **Version Control**: Git (command line or GUI)
|
- **Version Control**: Git (command line or GUI)
|
||||||
|
|
||||||
### 4.11 Local Development
|
### 4.11. Local Development
|
||||||
|
|
||||||
To run locally:
|
To run locally:
|
||||||
|
|
||||||
@@ -587,7 +587,7 @@ To run locally:
|
|||||||
- Install Live Server extension
|
- Install Live Server extension
|
||||||
- Right-click HTML file → "Open with Live Server"
|
- Right-click HTML file → "Open with Live Server"
|
||||||
|
|
||||||
### 4.12 Commit Message Guidelines
|
### 4.12. Commit Message Guidelines
|
||||||
|
|
||||||
Follow conventional commit format:
|
Follow conventional commit format:
|
||||||
|
|
||||||
@@ -643,14 +643,12 @@ feat: add search functionality to testimonials page
|
|||||||
|
|
||||||
- **Data Format**: Static HTML cards generated from source
|
- **Data Format**: Static HTML cards generated from source
|
||||||
- **Styling Features**:
|
- **Styling Features**:
|
||||||
- Screen-optimized and print-optimized views
|
- Screen-optimised and print-optimised views
|
||||||
- Responsive card layout
|
- Responsive card layout
|
||||||
- Chronological ordering
|
- Chronological ordering
|
||||||
- **Submission**: Via web form at `https://forms.nhcarrigan.com/form/M_GrmqASymmO744axMOmu2LaMAaT5F0LmdVcU2c8-gQ`
|
- **Submission**: Via web form at `https://forms.nhcarrigan.com/form/M_GrmqASymmO744axMOmu2LaMAaT5F0LmdVcU2c8-gQ`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Document Version**: 1.0
|
|
||||||
**Last Updated**: 2025-10-29
|
|
||||||
**Maintained By**: Naomi Carrigan
|
**Maintained By**: Naomi Carrigan
|
||||||
**Contact**: contact@nhcarrigan.com
|
**Contact**: contact@nhcarrigan.com
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
### Adding Tyche to Your Discord Server
|
### Adding Tyche to Your Discord Server
|
||||||
|
|
||||||
To add Tyche to your Discord server, use the following invite link:
|
To add Tyche to your Discord server, use the following invite link:
|
||||||
https://discord.com/oauth2/authorize?client_id=1436837822656020663
|
https://discord.com/oauth2/authorise?client_id=1436837822656020663
|
||||||
|
|
||||||
The bot requires the following permissions:
|
The bot requires the following permissions:
|
||||||
- View Channels (to see where commands are used)
|
- View Channels (to see where commands are used)
|
||||||
@@ -107,7 +107,7 @@ Total: **23**
|
|||||||
If you encounter issues or have questions:
|
If you encounter issues or have questions:
|
||||||
- Visit the support server: https://chat.nhcarrigan.com
|
- Visit the support server: https://chat.nhcarrigan.com
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- View the source code: https://git.nhcarrigan.com/nhcarrigan/tyche
|
- View the source code: https://git.nhcarrigan.com/NHCarrigan/tyche
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ Tyche is built with the following technologies:
|
|||||||
- **Fastify 5.6.1**: Web server for health monitoring
|
- **Fastify 5.6.1**: Web server for health monitoring
|
||||||
- **TypeScript 5.9.3**: Type-safe JavaScript development
|
- **TypeScript 5.9.3**: Type-safe JavaScript development
|
||||||
- **@nhcarrigan/discord-analytics**: Bot analytics and monitoring
|
- **@nhcarrigan/discord-analytics**: Bot analytics and monitoring
|
||||||
- **@nhcarrigan/logger**: Centralized logging system
|
- **@nhcarrigan/logger**: Centralised logging system
|
||||||
|
|
||||||
#### Project Structure
|
#### Project Structure
|
||||||
|
|
||||||
@@ -177,7 +177,7 @@ src/
|
|||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/tyche.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/tyche.git
|
||||||
cd tyche
|
cd tyche
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -248,7 +248,7 @@ node prod/index.js
|
|||||||
4. **Monitoring**:
|
4. **Monitoring**:
|
||||||
- Web server provides a basic health check endpoint
|
- Web server provides a basic health check endpoint
|
||||||
- Analytics are tracked via @nhcarrigan/discord-analytics
|
- Analytics are tracked via @nhcarrigan/discord-analytics
|
||||||
- Logging can be centralized using the LOG_TOKEN
|
- Logging can be centralised using the LOG_TOKEN
|
||||||
|
|
||||||
5. **Scaling**: As a stateless bot, multiple instances can run behind a load balancer if needed
|
5. **Scaling**: As a stateless bot, multiple instances can run behind a load balancer if needed
|
||||||
|
|
||||||
@@ -298,7 +298,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
Tyche is licensed under Naomi's Public License. The full license text can be found at:
|
Tyche is licensed under Naomi's Public Licence. The full licence text can be found at:
|
||||||
https://docs.nhcarrigan.com/#/license
|
https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
@@ -337,7 +337,7 @@ https://docs.nhcarrigan.com/#/privacy
|
|||||||
|
|
||||||
Tyche does not:
|
Tyche does not:
|
||||||
- Store message content
|
- Store message content
|
||||||
- Track individual user behavior across servers
|
- Track individual user behaviour across servers
|
||||||
- Share data with third parties
|
- Share data with third parties
|
||||||
- Use data for advertising or marketing
|
- Use data for advertising or marketing
|
||||||
|
|
||||||
@@ -383,7 +383,7 @@ Key principles:
|
|||||||
- Be respectful and inclusive
|
- Be respectful and inclusive
|
||||||
- Welcome newcomers
|
- Welcome newcomers
|
||||||
- Focus on constructive feedback
|
- Focus on constructive feedback
|
||||||
- No harassment or discriminatory behavior
|
- No harassment or discriminatory behaviour
|
||||||
|
|
||||||
### Development Setup
|
### Development Setup
|
||||||
|
|
||||||
@@ -409,8 +409,8 @@ Key conventions:
|
|||||||
- Copyright headers required on all source files:
|
- Copyright headers required on all source files:
|
||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright nhcarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
@@ -460,9 +460,9 @@ To test changes:
|
|||||||
### Reporting Issues
|
### Reporting Issues
|
||||||
|
|
||||||
When reporting bugs:
|
When reporting bugs:
|
||||||
- Use GitHub Issues at the source repository
|
- Post in the #bug-reports forum channel on our Discord community
|
||||||
- Include steps to reproduce
|
- Include steps to reproduce
|
||||||
- Include expected vs actual behavior
|
- Include expected vs actual behaviour
|
||||||
- Include relevant error messages or logs
|
- Include relevant error messages or logs
|
||||||
- Specify your environment (Node version, OS, etc.)
|
- Specify your environment (Node version, OS, etc.)
|
||||||
|
|
||||||
@@ -491,5 +491,4 @@ For questions or support:
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Documentation Version**: 1.0.0
|
**Documentation Version**: 1.0.0
|
||||||
**Last Updated**: 2025-11-12
|
|
||||||
**Application Version**: 0.0.0
|
**Application Version**: 0.0.0
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ TypeScript Config (hereinafter the "Application") is a shareable TypeScript comp
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Overview
|
### 1.1. Overview
|
||||||
|
|
||||||
The Application is a published npm package (`@nhcarrigan/typescript-config`) that provides a standardized TypeScript configuration. It enforces strict typing rules and modern ECMAScript standards to improve code quality and maintainability.
|
The Application is a published npm package (`@nhcarrigan/typescript-config`) that provides a standardised TypeScript configuration. It enforces strict typing rules and modern ECMAScript standards to improve code quality and maintainability.
|
||||||
|
|
||||||
### 1.2 Installation
|
### 1.2. Installation
|
||||||
|
|
||||||
To install the Application in your project, use the following command:
|
To install the Application in your project, use the following command:
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ Or with pnpm:
|
|||||||
pnpm add @nhcarrigan/typescript-config typescript
|
pnpm add @nhcarrigan/typescript-config typescript
|
||||||
```
|
```
|
||||||
|
|
||||||
### 1.3 Usage
|
### 1.3. Usage
|
||||||
|
|
||||||
After installation, extend the Application's configuration in your project's `tsconfig.json` file:
|
After installation, extend the Application's configuration in your project's `tsconfig.json` file:
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ After installation, extend the Application's configuration in your project's `ts
|
|||||||
- Set these directories to match your project's structure
|
- Set these directories to match your project's structure
|
||||||
- The Application is compatible with TypeScript 5 and above
|
- The Application is compatible with TypeScript 5 and above
|
||||||
|
|
||||||
### 1.4 Configuration Features
|
### 1.4. Configuration Features
|
||||||
|
|
||||||
The Application provides the following compiler options:
|
The Application provides the following compiler options:
|
||||||
|
|
||||||
@@ -73,23 +73,23 @@ The Application provides the following compiler options:
|
|||||||
- **Skip Lib Check**: Enabled - Skips type checking of declaration files
|
- **Skip Lib Check**: Enabled - Skips type checking of declaration files
|
||||||
- **Force Consistent Casing in Filenames**: Enabled - Ensures case-sensitive file imports
|
- **Force Consistent Casing in Filenames**: Enabled - Ensures case-sensitive file imports
|
||||||
|
|
||||||
### 1.5 Package Information
|
### 1.5. Package Information
|
||||||
|
|
||||||
- **Version**: 4.0.0
|
- **Version**: 4.0.0
|
||||||
- **NPM Package**: [@nhcarrigan/typescript-config](https://www.npmjs.com/package/@nhcarrigan/typescript-config)
|
- **NPM Package**: [@nhcarrigan/typescript-config](https://www.npmjs.com/package/@nhcarrigan/typescript-config)
|
||||||
- **Author**: Naomi Carrigan
|
- **Author**: Naomi Carrigan
|
||||||
- **License**: [Global Software License](https://docs.nhcarrigan.com/#/license)
|
- **License**: [Global Software Licence](https://docs.nhcarrigan.com/#/license)
|
||||||
|
|
||||||
### 1.6 Support and Feedback
|
### 1.6. Support and Feedback
|
||||||
|
|
||||||
- **Issues**: Report bugs at [Codeberg Issues](https://codeberg.org/naomi-lgbt/typescript-config/issues)
|
- **Issues**: Report bugs at [Codeberg Issues](https://codeberg.org/naomi-lgbt/typescript-config/issues)
|
||||||
- **Contact**: Available via [Chat Server](http://chat.nhcarrigan.com) or email at `contact@nhcarrigan.com`
|
- **Contact**: Available via [Chat Server](https://chat.nhcarrigan.com) or email at `contact@nhcarrigan.com`
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Project Structure
|
### 2.1. Project Structure
|
||||||
|
|
||||||
The Application has a minimal structure focused on distributing a TypeScript configuration:
|
The Application has a minimal structure focused on distributing a TypeScript configuration:
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ typescript-config/
|
|||||||
└── [documentation files] # README, LICENSE, CONTRIBUTING, etc.
|
└── [documentation files] # README, LICENSE, CONTRIBUTING, etc.
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.2 Source Code
|
### 2.2. Source Code
|
||||||
|
|
||||||
#### Configuration File (tsconfig.json:1)
|
#### Configuration File (tsconfig.json:1)
|
||||||
|
|
||||||
@@ -143,7 +143,7 @@ The source directory contains a minimal test file used to validate that the conf
|
|||||||
|
|
||||||
This file serves as a smoke test to ensure the TypeScript configuration is valid.
|
This file serves as a smoke test to ensure the TypeScript configuration is valid.
|
||||||
|
|
||||||
### 2.3 Development Setup
|
### 2.3. Development Setup
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
@@ -171,7 +171,7 @@ pnpm test
|
|||||||
|
|
||||||
The test script runs the TypeScript compiler with specific `rootDir` and `outDir` settings to validate the configuration.
|
The test script runs the TypeScript compiler with specific `rootDir` and `outDir` settings to validate the configuration.
|
||||||
|
|
||||||
### 2.4 Build and Test Process
|
### 2.4. Build and Test Process
|
||||||
|
|
||||||
The Application uses a simple test script defined in package.json:6:
|
The Application uses a simple test script defined in package.json:6:
|
||||||
|
|
||||||
@@ -184,20 +184,20 @@ This command:
|
|||||||
2. Outputs compiled JavaScript to the `prod` directory
|
2. Outputs compiled JavaScript to the `prod` directory
|
||||||
3. Confirms successful compilation with a success message
|
3. Confirms successful compilation with a success message
|
||||||
|
|
||||||
### 2.5 Publishing
|
### 2.5. Publishing
|
||||||
|
|
||||||
The Application is published to npm under the package name `@nhcarrigan/typescript-config`. The main entry point is the `tsconfig.json` file itself (as specified in package.json:5).
|
The Application is published to npm under the package name `@nhcarrigan/typescript-config`. The main entry point is the `tsconfig.json` file itself (as specified in package.json:5).
|
||||||
|
|
||||||
### 2.6 Version History
|
### 2.6. Version History
|
||||||
|
|
||||||
The current version is 4.0.0, which introduced breaking changes:
|
The current version is 4.0.0, which introduced breaking changes:
|
||||||
- Removed default `rootDir` and `outDir` settings
|
- Removed default `rootDir` and `outDir` settings
|
||||||
- Users must now explicitly set these in their project's `tsconfig.json`
|
- Users must now explicitly set these in their project's `tsconfig.json`
|
||||||
- This change resolves incompatibilities with certain package managers
|
- This change resolves incompatibilities with certain package managers
|
||||||
|
|
||||||
### 2.7 Design Decisions
|
### 2.7. Design Decisions
|
||||||
|
|
||||||
The configuration emphasizes:
|
The configuration emphasises:
|
||||||
1. **Strict Type Checking**: All strict options are enabled to catch potential errors at compile time
|
1. **Strict Type Checking**: All strict options are enabled to catch potential errors at compile time
|
||||||
2. **Modern JavaScript**: Targets ES2022 for modern language features
|
2. **Modern JavaScript**: Targets ES2022 for modern language features
|
||||||
3. **Code Quality**: Enforces best practices like no unused variables, no unreachable code
|
3. **Code Quality**: Enforces best practices like no unused variables, no unreachable code
|
||||||
@@ -207,31 +207,31 @@ The configuration emphasizes:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
The Application is licensed under the [Global Software License](https://docs.nhcarrigan.com/#/license). Copyright is held by Naomi Carrigan.
|
The Application is licensed under the [Global Software Licence](https://docs.nhcarrigan.com/#/license). Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
See LICENSE.md for full license details.
|
See LICENSE.md for full licence details.
|
||||||
|
|
||||||
### 3.2 Terms of Service
|
### 3.2. Terms of Service
|
||||||
|
|
||||||
Users of the Application are subject to the global Terms of Service available at [https://docs.nhcarrigan.com/#/terms](https://docs.nhcarrigan.com/#/terms).
|
Users of the Application are subject to the global Terms of Service available at [https://docs.nhcarrigan.com/#/terms](https://docs.nhcarrigan.com/#/terms).
|
||||||
|
|
||||||
See TERMS.md for reference.
|
See TERMS.md for reference.
|
||||||
|
|
||||||
### 3.3 Privacy Policy
|
### 3.3. Privacy Policy
|
||||||
|
|
||||||
The Application does not collect or transmit any user data. For general privacy policies, refer to [https://docs.nhcarrigan.com/#/privacy](https://docs.nhcarrigan.com/#/privacy).
|
The Application does not collect or transmit any user data. For general privacy policies, refer to [https://docs.nhcarrigan.com/#/privacy](https://docs.nhcarrigan.com/#/privacy).
|
||||||
|
|
||||||
See PRIVACY.md for reference.
|
See PRIVACY.md for reference.
|
||||||
|
|
||||||
### 3.4 Security Policy
|
### 3.4. Security Policy
|
||||||
|
|
||||||
Security vulnerabilities should be reported according to the guidelines at [https://docs.nhcarrigan.com/#/security](https://docs.nhcarrigan.com/#/security).
|
Security vulnerabilities should be reported according to the guidelines at [https://docs.nhcarrigan.com/#/security](https://docs.nhcarrigan.com/#/security).
|
||||||
|
|
||||||
See SECURITY.md for reference.
|
See SECURITY.md for reference.
|
||||||
|
|
||||||
### 3.5 Intellectual Property
|
### 3.5. Intellectual Property
|
||||||
|
|
||||||
The Application's configuration is an original work created by Naomi Carrigan. The specific combination of TypeScript compiler options represents curated decisions for code quality and safety.
|
The Application's configuration is an original work created by Naomi Carrigan. The specific combination of TypeScript compiler options represents curated decisions for code quality and safety.
|
||||||
|
|
||||||
@@ -239,17 +239,17 @@ The Application's configuration is an original work created by Naomi Carrigan. T
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Comprehensive contributing guidelines are available at [https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing).
|
Comprehensive contributing guidelines are available at [https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing).
|
||||||
|
|
||||||
See CONTRIBUTING.md for reference.
|
See CONTRIBUTING.md for reference.
|
||||||
|
|
||||||
### 4.2 Code of Conduct
|
### 4.2. Code of Conduct
|
||||||
|
|
||||||
Before interacting with the community, please review the Code of Conduct available in CODE_OF_CONDUCT.md.
|
Before interacting with the community, please review the Code of Conduct available in CODE_OF_CONDUCT.md.
|
||||||
|
|
||||||
### 4.3 How to Contribute
|
### 4.3. How to Contribute
|
||||||
|
|
||||||
#### Reporting Issues
|
#### Reporting Issues
|
||||||
|
|
||||||
@@ -275,7 +275,7 @@ When proposing changes to the TypeScript configuration:
|
|||||||
- Consider backward compatibility
|
- Consider backward compatibility
|
||||||
- Test with various TypeScript projects to ensure compatibility
|
- Test with various TypeScript projects to ensure compatibility
|
||||||
|
|
||||||
### 4.4 Development Workflow
|
### 4.4. Development Workflow
|
||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository
|
||||||
2. Create a branch for your changes
|
2. Create a branch for your changes
|
||||||
@@ -285,7 +285,7 @@ When proposing changes to the TypeScript configuration:
|
|||||||
6. Commit with clear, descriptive messages
|
6. Commit with clear, descriptive messages
|
||||||
7. Submit a Pull Request
|
7. Submit a Pull Request
|
||||||
|
|
||||||
### 4.5 Testing Changes
|
### 4.5. Testing Changes
|
||||||
|
|
||||||
To test configuration changes:
|
To test configuration changes:
|
||||||
1. Make modifications to `tsconfig.json`
|
1. Make modifications to `tsconfig.json`
|
||||||
@@ -300,14 +300,14 @@ To test configuration changes:
|
|||||||
```
|
```
|
||||||
4. Verify the configuration works as expected
|
4. Verify the configuration works as expected
|
||||||
|
|
||||||
### 4.6 Repository Information
|
### 4.6. Repository Information
|
||||||
|
|
||||||
- **Repository**: [https://codeberg.org/naomi-lgbt/typescript-config](https://codeberg.org/naomi-lgbt/typescript-config)
|
- **Repository**: [https://codeberg.org/naomi-lgbt/typescript-config](https://codeberg.org/naomi-lgbt/typescript-config)
|
||||||
- **Issue Tracker**: [https://codeberg.org/naomi-lgbt/typescript-config/issues](https://codeberg.org/naomi-lgbt/typescript-config/issues)
|
- **Issue Tracker**: [https://codeberg.org/naomi-lgbt/typescript-config/issues](https://codeberg.org/naomi-lgbt/typescript-config/issues)
|
||||||
- **Git URL**: `git@codeberg.org:naomi-lgbt/typescript-config.git`
|
- **Git URL**: `git@codeberg.org:naomi-lgbt/typescript-config.git`
|
||||||
|
|
||||||
### 4.7 Contact
|
### 4.7. Contact
|
||||||
|
|
||||||
For questions about contributing:
|
For questions about contributing:
|
||||||
- Join the [Chat Server](http://chat.nhcarrigan.com)
|
- Join the [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email: `contact@nhcarrigan.com`
|
- Email: `contact@nhcarrigan.com`
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
1. **Adding Umbrelle to Your Server**
|
1. **Adding Umbrelle to Your Server**
|
||||||
- Use the Discord OAuth2 authorization link: https://discord.com/oauth2/authorize?client_id=1412945347134881862
|
- Use the Discord OAuth2 authorisation link: https://discord.com/oauth2/authorise?client_id=1412945347134881862
|
||||||
- Ensure you have "Manage Server" permissions to add bots
|
- Ensure you have "Manage Server" permissions to add bots
|
||||||
|
|
||||||
2. **Setting Up a Honeypot Channel**
|
2. **Setting Up a Honeypot Channel**
|
||||||
@@ -37,7 +37,7 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
If you need assistance:
|
If you need assistance:
|
||||||
- Join the support Discord server: https://chat.nhcarrigan.com
|
- Join the support Discord server: https://chat.nhcarrigan.com
|
||||||
- Visit the documentation: https://docs.nhcarrigan.com/
|
- Visit the documentation: https://docs.nhcarrigan.com/
|
||||||
- View source code: https://git.nhcarrigan.com/nhcarrigan/umbrelle
|
- View source code: https://git.nhcarrigan.com/NHCarrigan/umbrelle
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
This application is licensed under Naomi's Public License. The full license text can be found in the LICENSE.md file in the repository.
|
This application is licensed under Naomi's Public Licence. The full licence text can be found in the LICENSE.md file in the repository.
|
||||||
|
|
||||||
### Copyright
|
### Copyright
|
||||||
|
|
||||||
@@ -211,4 +211,4 @@ Currently, the project has placeholder tests. Contributors are welcome to:
|
|||||||
For development questions and support:
|
For development questions and support:
|
||||||
- Join the Discord community: https://chat.nhcarrigan.com
|
- Join the Discord community: https://chat.nhcarrigan.com
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- Review existing GitHub issues and discussions
|
- Review existing discussions in the Discord forum channels (#bug-reports or #feature-requests)
|
||||||
|
|||||||
@@ -145,7 +145,7 @@ The application includes a Fastify web server on port 6099 that serves:
|
|||||||
|
|
||||||
The bot can be invited with this URL:
|
The bot can be invited with this URL:
|
||||||
```
|
```
|
||||||
https://discord.com/oauth2/authorize?client_id=1391505285465509978
|
https://discord.com/oauth2/authorise?client_id=1391505285465509978
|
||||||
```
|
```
|
||||||
|
|
||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
@@ -155,7 +155,7 @@ This section is for expansions to our legal policies specific to the Application
|
|||||||
### Licensing
|
### Licensing
|
||||||
|
|
||||||
- **Copyright**: NHCarrigan
|
- **Copyright**: NHCarrigan
|
||||||
- **License**: Naomi's Public License
|
- **License**: Naomi's Public Licence
|
||||||
- **Author**: Naomi Carrigan
|
- **Author**: Naomi Carrigan
|
||||||
|
|
||||||
### Data Handling
|
### Data Handling
|
||||||
|
|||||||
@@ -8,18 +8,18 @@ Vivicrea (hereinafter the "Application") is a Discord bot that generates AI-powe
|
|||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Overview
|
### 1.1. Overview
|
||||||
|
|
||||||
Vivicrea is a specialized Discord bot designed to generate consistent, high-quality anime-style artwork of a specific character. The bot uses advanced AI image generation technology to create unique images while maintaining character consistency across all generated artwork.
|
Vivicrea is a specialised Discord bot designed to generate consistent, high-quality anime-style artwork of a specific character. The bot uses advanced AI image generation technology to create unique images while maintaining character consistency across all generated artwork.
|
||||||
|
|
||||||
### 1.2 How to Use
|
### 1.2. How to Use
|
||||||
|
|
||||||
#### 1.2.1 Prerequisites
|
#### 1.2.1. Prerequisites
|
||||||
|
|
||||||
- Access to a Discord server where the bot is installed
|
- Access to a Discord server where the bot is installed
|
||||||
- Authorization from the bot owner (currently restricted to user ID: 465650873650118659)
|
- Authorization from the bot owner (currently restricted to user ID: 465650873650118659)
|
||||||
|
|
||||||
#### 1.2.2 Generating an Image
|
#### 1.2.2. Generating an Image
|
||||||
|
|
||||||
1. **Mention the Bot**: Mention the bot in any channel where it has access
|
1. **Mention the Bot**: Mention the bot in any channel where it has access
|
||||||
- The bot listens for direct mentions only (ignores @everyone, @here, and role mentions)
|
- The bot listens for direct mentions only (ignores @everyone, @here, and role mentions)
|
||||||
@@ -31,15 +31,15 @@ Vivicrea is a specialized Discord bot designed to generate consistent, high-qual
|
|||||||
- The character will be depicted with consistent features (shoulder-length wavy light dusty brown hair, light blue eyes, pink glasses, etc.)
|
- The character will be depicted with consistent features (shoulder-length wavy light dusty brown hair, light blue eyes, pink glasses, etc.)
|
||||||
- Each generation creates a unique pose, outfit, or setting
|
- Each generation creates a unique pose, outfit, or setting
|
||||||
|
|
||||||
#### 1.2.3 Access Restrictions
|
#### 1.2.3. Access Restrictions
|
||||||
|
|
||||||
Currently, the Application only accepts image generation requests from a single authorized user (Naomi). Other users will receive a polite message indicating the restriction:
|
Currently, the Application only accepts image generation requests from a single authorised user (Naomi). Other users will receive a polite message indicating the restriction:
|
||||||
|
|
||||||
> "Sorry, I can only generate images for Naomi."
|
> "Sorry, I can only generate images for Naomi."
|
||||||
|
|
||||||
This restriction is intentional and ensures the bot serves its primary purpose.
|
This restriction is intentional and ensures the bot serves its primary purpose.
|
||||||
|
|
||||||
### 1.3 Character Reference
|
### 1.3. Character Reference
|
||||||
|
|
||||||
All generated images maintain the following character features:
|
All generated images maintain the following character features:
|
||||||
- **Name**: Naomi
|
- **Name**: Naomi
|
||||||
@@ -50,7 +50,7 @@ All generated images maintain the following character features:
|
|||||||
- **Details**: Small vampire fangs, gentle smile, barefoot with pink nail polish
|
- **Details**: Small vampire fangs, gentle smile, barefoot with pink nail polish
|
||||||
- **Style**: Anime-style full body art, clean, detailed, and vibrant
|
- **Style**: Anime-style full body art, clean, detailed, and vibrant
|
||||||
|
|
||||||
### 1.4 Limitations
|
### 1.4. Limitations
|
||||||
|
|
||||||
- The bot only responds to mentions in channels it can access
|
- The bot only responds to mentions in channels it can access
|
||||||
- Image generation may take several seconds depending on API response times
|
- Image generation may take several seconds depending on API response times
|
||||||
@@ -61,7 +61,7 @@ All generated images maintain the following character features:
|
|||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Architecture
|
### 2.1. Architecture
|
||||||
|
|
||||||
The Application is built using the following technology stack:
|
The Application is built using the following technology stack:
|
||||||
|
|
||||||
@@ -70,9 +70,9 @@ The Application is built using the following technology stack:
|
|||||||
- **AI Provider**: Google GenAI (@google/genai) v1.28.0
|
- **AI Provider**: Google GenAI (@google/genai) v1.28.0
|
||||||
- **Logging**: @nhcarrigan/logger v1.1.1
|
- **Logging**: @nhcarrigan/logger v1.1.1
|
||||||
- **Analytics**: @nhcarrigan/discord-analytics v0.0.6
|
- **Analytics**: @nhcarrigan/discord-analytics v0.0.6
|
||||||
- **Web Server**: fastify v5.6.1 (included but not currently utilized)
|
- **Web Server**: fastify v5.6.1 (included but not currently utilised)
|
||||||
|
|
||||||
### 2.2 Project Structure
|
### 2.2. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
Vivicrea/
|
Vivicrea/
|
||||||
@@ -85,7 +85,7 @@ Vivicrea/
|
|||||||
└── prod/ # Compiled JavaScript output (generated)
|
└── prod/ # Compiled JavaScript output (generated)
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.3 Prerequisites
|
### 2.3. Prerequisites
|
||||||
|
|
||||||
Before running the Application, ensure you have:
|
Before running the Application, ensure you have:
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ Before running the Application, ensure you have:
|
|||||||
- A Google Gemini API Key (with access to gemini-2.5-flash-image model)
|
- A Google Gemini API Key (with access to gemini-2.5-flash-image model)
|
||||||
- A logging service token (for @nhcarrigan/logger)
|
- A logging service token (for @nhcarrigan/logger)
|
||||||
|
|
||||||
### 2.4 Installation
|
### 2.4. Installation
|
||||||
|
|
||||||
1. **Clone the repository**:
|
1. **Clone the repository**:
|
||||||
```bash
|
```bash
|
||||||
@@ -115,7 +115,7 @@ Before running the Application, ensure you have:
|
|||||||
pnpm run build
|
pnpm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.5 Configuration
|
### 2.5. Configuration
|
||||||
|
|
||||||
The Application requires three environment variables to be set:
|
The Application requires three environment variables to be set:
|
||||||
|
|
||||||
@@ -137,7 +137,7 @@ op run --env-file=prod.env -- node prod/index.js
|
|||||||
|
|
||||||
Alternatively, you can use a standard `.env` file or set environment variables directly in your deployment environment.
|
Alternatively, you can use a standard `.env` file or set environment variables directly in your deployment environment.
|
||||||
|
|
||||||
### 2.6 Running the Application
|
### 2.6. Running the Application
|
||||||
|
|
||||||
#### Development Mode
|
#### Development Mode
|
||||||
|
|
||||||
@@ -162,7 +162,7 @@ pnpm start
|
|||||||
node prod/index.js
|
node prod/index.js
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.7 Available Scripts
|
### 2.7. Available Scripts
|
||||||
|
|
||||||
| Script | Command | Description |
|
| Script | Command | Description |
|
||||||
|--------|---------|-------------|
|
|--------|---------|-------------|
|
||||||
@@ -171,7 +171,7 @@ node prod/index.js
|
|||||||
| `start` | `op run --env-file=prod.env -- node prod/index.js` | Starts the bot in production mode with 1Password env management |
|
| `start` | `op run --env-file=prod.env -- node prod/index.js` | Starts the bot in production mode with 1Password env management |
|
||||||
| `test` | `echo "Error: no test specified" && exit 0` | Placeholder (no tests currently implemented) |
|
| `test` | `echo "Error: no test specified" && exit 0` | Placeholder (no tests currently implemented) |
|
||||||
|
|
||||||
### 2.8 Discord Bot Setup
|
### 2.8. Discord Bot Setup
|
||||||
|
|
||||||
1. **Create a Discord Application**:
|
1. **Create a Discord Application**:
|
||||||
- Visit the [Discord Developer Portal](https://discord.com/developers/applications)
|
- Visit the [Discord Developer Portal](https://discord.com/developers/applications)
|
||||||
@@ -198,7 +198,7 @@ node prod/index.js
|
|||||||
- Right-click your bot and select "Copy ID"
|
- Right-click your bot and select "Copy ID"
|
||||||
- Update the hardcoded bot ID in `src/index.ts:36` if needed
|
- Update the hardcoded bot ID in `src/index.ts:36` if needed
|
||||||
|
|
||||||
### 2.9 Customization
|
### 2.9. Customization
|
||||||
|
|
||||||
#### Modifying the Character Prompt
|
#### Modifying the Character Prompt
|
||||||
|
|
||||||
@@ -223,7 +223,7 @@ Image generation settings are configured in `src/classes/ai.ts:34-36`:
|
|||||||
- `aspectRatio`: Currently set to "16:9", can be modified to other supported ratios
|
- `aspectRatio`: Currently set to "16:9", can be modified to other supported ratios
|
||||||
- `model`: Currently uses "gemini-2.5-flash-image", can be updated to other Gemini models
|
- `model`: Currently uses "gemini-2.5-flash-image", can be updated to other Gemini models
|
||||||
|
|
||||||
### 2.10 Troubleshooting
|
### 2.10. Troubleshooting
|
||||||
|
|
||||||
#### Bot Not Responding
|
#### Bot Not Responding
|
||||||
|
|
||||||
@@ -245,7 +245,7 @@ Image generation settings are configured in `src/classes/ai.ts:34-36`:
|
|||||||
2. Verify all dependencies are installed: `pnpm install`
|
2. Verify all dependencies are installed: `pnpm install`
|
||||||
3. Check for TypeScript errors: `pnpm run lint`
|
3. Check for TypeScript errors: `pnpm run lint`
|
||||||
|
|
||||||
### 2.11 Monitoring and Logging
|
### 2.11. Monitoring and Logging
|
||||||
|
|
||||||
The Application uses `@nhcarrigan/logger` for structured logging:
|
The Application uses `@nhcarrigan/logger` for structured logging:
|
||||||
|
|
||||||
@@ -253,7 +253,7 @@ The Application uses `@nhcarrigan/logger` for structured logging:
|
|||||||
- The logger requires a `LOG_TOKEN` environment variable
|
- The logger requires a `LOG_TOKEN` environment variable
|
||||||
- Logs are identified with the service name "Vivicrea"
|
- Logs are identified with the service name "Vivicrea"
|
||||||
|
|
||||||
### 2.12 Deployment Considerations
|
### 2.12. Deployment Considerations
|
||||||
|
|
||||||
- The Application maintains no persistent state (stateless)
|
- The Application maintains no persistent state (stateless)
|
||||||
- No database is required
|
- No database is required
|
||||||
@@ -265,26 +265,26 @@ The Application uses `@nhcarrigan/logger` for structured logging:
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 Applicable Policies
|
### 3.1. Applicable Policies
|
||||||
|
|
||||||
The Application operates under the following legal framework maintained by NHCarrigan:
|
The Application operates under the following legal framework maintained by NHCarrigan:
|
||||||
|
|
||||||
- **Software License**: [Global Software License](https://docs.nhcarrigan.com/#/license)
|
- **Software License**: [Global Software Licence](https://docs.nhcarrigan.com/#/license)
|
||||||
- **Terms of Service**: [Terms of Service](https://docs.nhcarrigan.com/#/terms)
|
- **Terms of Service**: [Terms of Service](https://docs.nhcarrigan.com/#/terms)
|
||||||
- **Privacy Policy**: [Privacy Policy](https://docs.nhcarrigan.com/#/privacy)
|
- **Privacy Policy**: [Privacy Policy](https://docs.nhcarrigan.com/#/privacy)
|
||||||
- **Code of Conduct**: Available in the repository
|
- **Code of Conduct**: Available in the repository
|
||||||
|
|
||||||
All users, contributors, and operators of the Application are subject to these policies.
|
All users, contributors, and operators of the Application are subject to these policies.
|
||||||
|
|
||||||
### 3.2 Copyright and Ownership
|
### 3.2. Copyright and Ownership
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
The Application's source code is licensed under Naomi's Public License. Please refer to the [LICENSE.md](LICENSE.md) file and the global software license documentation for full terms.
|
The Application's source code is licensed under Naomi's Public Licence. Please refer to the [LICENSE.md](LICENSE.md) file and the global software licence documentation for full terms.
|
||||||
|
|
||||||
### 3.3 Data Processing
|
### 3.3. Data Processing
|
||||||
|
|
||||||
#### 3.3.1 Discord Data
|
#### 3.3.1. Discord Data
|
||||||
|
|
||||||
The Application processes the following Discord data:
|
The Application processes the following Discord data:
|
||||||
- Guild (server) information for bot operation
|
- Guild (server) information for bot operation
|
||||||
@@ -292,7 +292,7 @@ The Application processes the following Discord data:
|
|||||||
- User IDs for access control
|
- User IDs for access control
|
||||||
- Channel IDs for sending responses
|
- Channel IDs for sending responses
|
||||||
|
|
||||||
#### 3.3.2 Third-Party Data Sharing
|
#### 3.3.2. Third-Party Data Sharing
|
||||||
|
|
||||||
The Application shares data with the following third-party services:
|
The Application shares data with the following third-party services:
|
||||||
|
|
||||||
@@ -300,20 +300,20 @@ The Application shares data with the following third-party services:
|
|||||||
2. **Google Gemini API**: Character description prompts (no user-generated content is sent)
|
2. **Google Gemini API**: Character description prompts (no user-generated content is sent)
|
||||||
3. **Logging Service**: Application debug information and operational logs
|
3. **Logging Service**: Application debug information and operational logs
|
||||||
|
|
||||||
#### 3.3.3 Data Retention
|
#### 3.3.3. Data Retention
|
||||||
|
|
||||||
- The Application does not store message content or user data persistently
|
- The Application does not store message content or user data persistently
|
||||||
- All data processing is transient and in-memory only
|
- All data processing is transient and in-memory only
|
||||||
- Generated images are delivered via Discord and not stored by the Application
|
- Generated images are delivered via Discord and not stored by the Application
|
||||||
- Logs may be retained according to the logging service's retention policy
|
- Logs may be retained according to the logging service's retention policy
|
||||||
|
|
||||||
### 3.4 Generated Content Rights
|
### 3.4. Generated Content Rights
|
||||||
|
|
||||||
All images generated by the Application are created using Google's Gemini AI model. Users should refer to Google's terms of service regarding AI-generated content ownership and usage rights.
|
All images generated by the Application are created using Google's Gemini AI model. Users should refer to Google's terms of service regarding AI-generated content ownership and usage rights.
|
||||||
|
|
||||||
The character design and reference used in the prompts are the intellectual property of Naomi Carrigan.
|
The character design and reference used in the prompts are the intellectual property of Naomi Carrigan.
|
||||||
|
|
||||||
### 3.5 API Usage and Compliance
|
### 3.5. API Usage and Compliance
|
||||||
|
|
||||||
Operators of the Application are responsible for:
|
Operators of the Application are responsible for:
|
||||||
- Complying with Discord's Terms of Service and Developer Terms
|
- Complying with Discord's Terms of Service and Developer Terms
|
||||||
@@ -321,7 +321,7 @@ Operators of the Application are responsible for:
|
|||||||
- Maintaining valid API keys and not exceeding rate limits
|
- Maintaining valid API keys and not exceeding rate limits
|
||||||
- Ensuring proper attribution when required by service providers
|
- Ensuring proper attribution when required by service providers
|
||||||
|
|
||||||
### 3.6 Modifications to Legal Policies
|
### 3.6. Modifications to Legal Policies
|
||||||
|
|
||||||
The legal policies linked in this documentation may be updated by NHCarrigan from time to time. Users and operators should periodically review the linked policies for any changes.
|
The legal policies linked in this documentation may be updated by NHCarrigan from time to time. Users and operators should periodically review the linked policies for any changes.
|
||||||
|
|
||||||
@@ -329,18 +329,18 @@ The legal policies linked in this documentation may be updated by NHCarrigan fro
|
|||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 General Contributing Guidelines
|
### 4.1. General Contributing Guidelines
|
||||||
|
|
||||||
All contributions to the Application must follow the general contributing guidelines available at:
|
All contributions to the Application must follow the general contributing guidelines available at:
|
||||||
[https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing)
|
[https://docs.nhcarrigan.com/#/contributing](https://docs.nhcarrigan.com/#/contributing)
|
||||||
|
|
||||||
Please review these guidelines thoroughly before submitting any contributions.
|
Please review these guidelines thoroughly before submitting any contributions.
|
||||||
|
|
||||||
### 4.2 Code of Conduct
|
### 4.2. Code of Conduct
|
||||||
|
|
||||||
Before interacting with the project or community, please read and agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
|
Before interacting with the project or community, please read and agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
### 4.3 Development Environment Setup
|
### 4.3. Development Environment Setup
|
||||||
|
|
||||||
1. **Fork and clone the repository**:
|
1. **Fork and clone the repository**:
|
||||||
```bash
|
```bash
|
||||||
@@ -357,23 +357,23 @@ Before interacting with the project or community, please read and agree to abide
|
|||||||
|
|
||||||
4. **Make your changes** following the project's coding standards
|
4. **Make your changes** following the project's coding standards
|
||||||
|
|
||||||
### 4.4 Coding Standards
|
### 4.4. Coding Standards
|
||||||
|
|
||||||
The project uses the following code quality tools:
|
The project uses the following code quality tools:
|
||||||
|
|
||||||
#### 4.4.1 ESLint
|
#### 4.4.1. ESLint
|
||||||
|
|
||||||
- Configuration: `@nhcarrigan/eslint-config` v5.2.0
|
- Configuration: `@nhcarrigan/eslint-config` v5.2.0
|
||||||
- Run linting: `pnpm run lint`
|
- Run linting: `pnpm run lint`
|
||||||
- Zero warnings policy: All ESLint warnings must be resolved
|
- Zero warnings policy: All ESLint warnings must be resolved
|
||||||
|
|
||||||
#### 4.4.2 TypeScript
|
#### 4.4.2. TypeScript
|
||||||
|
|
||||||
- Configuration: `@nhcarrigan/typescript-config` v4.0.0
|
- Configuration: `@nhcarrigan/typescript-config` v4.0.0
|
||||||
- TypeScript version: 5.9.3
|
- TypeScript version: 5.9.3
|
||||||
- All code must be properly typed (no `any` types without justification)
|
- All code must be properly typed (no `any` types without justification)
|
||||||
|
|
||||||
#### 4.4.3 Code Style
|
#### 4.4.3. Code Style
|
||||||
|
|
||||||
- Follow the existing code style in the project
|
- Follow the existing code style in the project
|
||||||
- Use clear, descriptive variable and function names
|
- Use clear, descriptive variable and function names
|
||||||
@@ -382,12 +382,12 @@ The project uses the following code quality tools:
|
|||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
* @copyright NHCarrigan
|
* @copyright NHCarrigan
|
||||||
* @license Naomi's Public License
|
* @license Naomi's Public Licence
|
||||||
* @author Naomi Carrigan
|
* @author Naomi Carrigan
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.5 Project Structure Guidelines
|
### 4.5. Project Structure Guidelines
|
||||||
|
|
||||||
When adding new features:
|
When adding new features:
|
||||||
|
|
||||||
@@ -396,7 +396,7 @@ When adding new features:
|
|||||||
- **Imports**: Use ES modules syntax with `.js` extensions (for TypeScript module resolution)
|
- **Imports**: Use ES modules syntax with `.js` extensions (for TypeScript module resolution)
|
||||||
- **Async**: Use async/await for asynchronous operations
|
- **Async**: Use async/await for asynchronous operations
|
||||||
|
|
||||||
### 4.6 Testing
|
### 4.6. Testing
|
||||||
|
|
||||||
Currently, the project does not have a test suite implemented. When contributing:
|
Currently, the project does not have a test suite implemented. When contributing:
|
||||||
|
|
||||||
@@ -407,9 +407,9 @@ Currently, the project does not have a test suite implemented. When contributing
|
|||||||
|
|
||||||
Future contributions to add a testing framework would be welcome.
|
Future contributions to add a testing framework would be welcome.
|
||||||
|
|
||||||
### 4.7 Submitting Contributions
|
### 4.7. Submitting Contributions
|
||||||
|
|
||||||
#### 4.7.1 Pull Request Process
|
#### 4.7.1. Pull Request Process
|
||||||
|
|
||||||
1. **Create a feature branch**:
|
1. **Create a feature branch**:
|
||||||
```bash
|
```bash
|
||||||
@@ -441,7 +441,7 @@ Future contributions to add a testing framework would be welcome.
|
|||||||
- Any relevant issue numbers
|
- Any relevant issue numbers
|
||||||
- Screenshots or examples if applicable
|
- Screenshots or examples if applicable
|
||||||
|
|
||||||
#### 4.7.2 Pull Request Guidelines
|
#### 4.7.2. Pull Request Guidelines
|
||||||
|
|
||||||
- Keep PRs focused on a single feature or fix
|
- Keep PRs focused on a single feature or fix
|
||||||
- Update documentation if adding new features
|
- Update documentation if adding new features
|
||||||
@@ -449,55 +449,55 @@ Future contributions to add a testing framework would be welcome.
|
|||||||
- Respond to review feedback promptly
|
- Respond to review feedback promptly
|
||||||
- Be respectful and professional in all interactions
|
- Be respectful and professional in all interactions
|
||||||
|
|
||||||
### 4.8 Issue Reporting
|
### 4.8. Issue Reporting
|
||||||
|
|
||||||
When reporting bugs or requesting features:
|
When reporting bugs or requesting features:
|
||||||
|
|
||||||
1. **Check existing issues** to avoid duplicates
|
1. **Check existing issues** to avoid duplicates
|
||||||
2. **Use descriptive titles** that summarize the issue
|
2. **Use descriptive titles** that summarise the issue
|
||||||
3. **Provide detailed information**:
|
3. **Provide detailed information**:
|
||||||
- Steps to reproduce (for bugs)
|
- Steps to reproduce (for bugs)
|
||||||
- Expected behavior
|
- Expected behaviour
|
||||||
- Actual behavior
|
- Actual behaviour
|
||||||
- Environment details (Node version, OS, etc.)
|
- Environment details (Node version, OS, etc.)
|
||||||
- Error messages or logs
|
- Error messages or logs
|
||||||
4. **Be patient** - maintainers will respond as soon as possible
|
4. **Be patient** - maintainers will respond as soon as possible
|
||||||
|
|
||||||
### 4.9 Areas for Contribution
|
### 4.9. Areas for Contribution
|
||||||
|
|
||||||
The following areas would benefit from community contributions:
|
The following areas would benefit from community contributions:
|
||||||
|
|
||||||
#### 4.9.1 High Priority
|
#### 4.9.1. High Priority
|
||||||
|
|
||||||
- Implement a test suite (unit and integration tests)
|
- Implement a test suite (unit and integration tests)
|
||||||
- Add error handling improvements
|
- Add error handling improvements
|
||||||
- Implement rate limiting for image generation
|
- Implement rate limiting for image generation
|
||||||
- Add configuration file support (vs. hardcoded values)
|
- Add configuration file support (vs. hardcoded values)
|
||||||
|
|
||||||
#### 4.9.2 Medium Priority
|
#### 4.9.2. Medium Priority
|
||||||
|
|
||||||
- Utilize the Fastify dependency for health check endpoints
|
- Utilize the Fastify dependency for health check endpoints
|
||||||
- Add metrics and monitoring instrumentation
|
- Add metrics and monitoring instrumentation
|
||||||
- Implement slash commands in addition to mentions
|
- Implement slash commands in addition to mentions
|
||||||
- Add queue system for image generation requests
|
- Add queue system for image generation requests
|
||||||
|
|
||||||
#### 4.9.3 Low Priority
|
#### 4.9.3. Low Priority
|
||||||
|
|
||||||
- Add support for multiple characters
|
- Add support for multiple characters
|
||||||
- Implement image history/gallery features
|
- Implement image history/gallery features
|
||||||
- Add customization options for image generation parameters
|
- Add customisation options for image generation parameters
|
||||||
- Create a web dashboard for configuration
|
- Create a web dashboard for configuration
|
||||||
|
|
||||||
### 4.10 Getting Help
|
### 4.10. Getting Help
|
||||||
|
|
||||||
If you need help with contributing:
|
If you need help with contributing:
|
||||||
|
|
||||||
- Review the [NHCarrigan documentation](https://docs.nhcarrigan.com)
|
- Review the [NHCarrigan documentation](https://docs.nhcarrigan.com)
|
||||||
- Open a GitHub issue with your question
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Contact via [Chat Server](http://chat.nhcarrigan.com)
|
- Contact via [Chat Server](https://chat.nhcarrigan.com)
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
### 4.11 Security Vulnerabilities
|
### 4.11. Security Vulnerabilities
|
||||||
|
|
||||||
If you discover a security vulnerability:
|
If you discover a security vulnerability:
|
||||||
|
|
||||||
@@ -506,9 +506,9 @@ If you discover a security vulnerability:
|
|||||||
- Contact the maintainer privately
|
- Contact the maintainer privately
|
||||||
- Allow time for the vulnerability to be addressed before public disclosure
|
- Allow time for the vulnerability to be addressed before public disclosure
|
||||||
|
|
||||||
### 4.12 Recognition
|
### 4.12. Recognition
|
||||||
|
|
||||||
Contributors will be recognized in the following ways:
|
Contributors will be recognised in the following ways:
|
||||||
- GitHub contribution history
|
- GitHub contribution history
|
||||||
- Potential inclusion in project acknowledgments
|
- Potential inclusion in project acknowledgments
|
||||||
- Community recognition and thanks
|
- Community recognition and thanks
|
||||||
@@ -518,5 +518,4 @@ Thank you for your interest in contributing to Vivicrea!
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Documentation Version**: 1.0.0
|
**Documentation Version**: 1.0.0
|
||||||
**Last Updated**: 2025-11-12
|
|
||||||
**Maintained By**: Naomi Carrigan
|
**Maintained By**: Naomi Carrigan
|
||||||
|
|||||||
@@ -2,33 +2,33 @@
|
|||||||
title: Naomi's VSCode Themes
|
title: Naomi's VSCode Themes
|
||||||
---
|
---
|
||||||
|
|
||||||
Naomi's VSCode Themes (hereinafter the "Application") is a Visual Studio Code extension that provides a curated collection of custom color themes designed to enhance the coding experience with aesthetically pleasing color schemes. The Application currently offers four distinct themes: Ocean Breeze, Sakura Dreams, Sakura Dreams (Dark), and Trans Pride.
|
Naomi's VSCode Themes (hereinafter the "Application") is a Visual Studio Code extension that provides a curated collection of custom colour themes designed to enhance the coding experience with aesthetically pleasing colour schemes. The Application currently offers four distinct themes: Ocean Breeze, Sakura Dreams, Sakura Dreams (Dark), and Trans Pride.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
This section is for those interacting with a live instance of the Application.
|
||||||
|
|
||||||
### 1.1 Overview
|
### 1.1. Overview
|
||||||
|
|
||||||
Naomi's Themes is a VSCode extension that provides custom color themes for your code editor. Each theme has been carefully crafted with specific color palettes to create visually appealing and comfortable coding environments.
|
Naomi's Themes is a VSCode extension that provides custom colour themes for your code editor. Each theme has been carefully crafted with specific colour palettes to create visually appealing and comfortable coding environments.
|
||||||
|
|
||||||
### 1.2 Available Themes
|
### 1.2. Available Themes
|
||||||
|
|
||||||
The Application includes the following themes:
|
The Application includes the following themes:
|
||||||
|
|
||||||
- **Ocean Breeze**: A dark theme featuring soothing teal and cyan colors reminiscent of ocean waves, designed for extended coding sessions with reduced eye strain
|
- **Ocean Breeze**: A dark theme featuring soothing teal and cyan colours reminiscent of ocean waves, designed for extended coding sessions with reduced eye strain
|
||||||
- **Sakura Dreams**: A light theme inspired by cherry blossoms with soft, pastel colors
|
- **Sakura Dreams**: A light theme inspired by cherry blossoms with soft, pastel colours
|
||||||
- **Sakura Dreams (Dark)**: A dark variant of the Sakura Dreams theme, maintaining the cherry blossom aesthetic while providing a darker background
|
- **Sakura Dreams (Dark)**: A dark variant of the Sakura Dreams theme, maintaining the cherry blossom aesthetic while providing a darker background
|
||||||
- **Trans Pride**: A light theme celebrating trans pride with a carefully selected color palette
|
- **Trans Pride**: A light theme celebrating trans pride with a carefully selected colour palette
|
||||||
|
|
||||||
### 1.3 Installation
|
### 1.3. Installation
|
||||||
|
|
||||||
1. Open Visual Studio Code
|
1. Open Visual Studio Code
|
||||||
2. Navigate to the Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
|
2. Navigate to the Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
|
||||||
3. Search for "Naomi's Themes" by nhcarrigan
|
3. Search for "Naomi's Themes" by NHCarrigan
|
||||||
4. Click "Install"
|
4. Click "Install"
|
||||||
|
|
||||||
### 1.4 Activating a Theme
|
### 1.4. Activating a Theme
|
||||||
|
|
||||||
After installation:
|
After installation:
|
||||||
|
|
||||||
@@ -40,31 +40,31 @@ After installation:
|
|||||||
- Sakura Dreams (Dark)
|
- Sakura Dreams (Dark)
|
||||||
- Trans Pride
|
- Trans Pride
|
||||||
|
|
||||||
### 1.5 Requirements
|
### 1.5. Requirements
|
||||||
|
|
||||||
- Visual Studio Code version 1.96.4 or higher
|
- Visual Studio Code version 1.96.4 or higher
|
||||||
|
|
||||||
### 1.6 Support and Feedback
|
### 1.6. Support and Feedback
|
||||||
|
|
||||||
If you encounter any issues or have feedback:
|
If you encounter any issues or have feedback:
|
||||||
|
|
||||||
- Open an issue at: https://git.nhcarrigan.com/nhcarrigan/vscode-themes/issues
|
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Contact via Chat Server: http://chat.nhcarrigan.com
|
- Contact via Chat Server: https://chat.nhcarrigan.com
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
This section is for those interested in running their own instance of the Application.
|
||||||
|
|
||||||
### 2.1 Architecture
|
### 2.1. Architecture
|
||||||
|
|
||||||
The Application is structured as a standard VSCode extension with the following components:
|
The Application is structured as a standard VSCode extension with the following components:
|
||||||
|
|
||||||
- **Theme Definitions**: JSON files located in the `themes/` directory, each defining color schemes for UI elements and syntax highlighting
|
- **Theme Definitions**: JSON files located in the `themes/` directory, each defining colour schemes for UI elements and syntax highlighting
|
||||||
- **Extension Manifest**: `package.json` containing metadata and theme contributions
|
- **Extension Manifest**: `package.json` containing metadata and theme contributions
|
||||||
- **Assets**: `icon.png` for the extension icon
|
- **Assets**: `icon.png` for the extension icon
|
||||||
|
|
||||||
### 2.2 Project Structure
|
### 2.2. Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
vscode-themes/
|
vscode-themes/
|
||||||
@@ -84,7 +84,7 @@ vscode-themes/
|
|||||||
└── SECURITY.md
|
└── SECURITY.md
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.3 Local Development Setup
|
### 2.3. Local Development Setup
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ vscode-themes/
|
|||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nhcarrigan.com/nhcarrigan/vscode-themes.git
|
git clone https://git.nhcarrigan.com/NHCarrigan/vscode-themes.git
|
||||||
cd vscode-themes
|
cd vscode-themes
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -117,7 +117,7 @@ vscode-themes/
|
|||||||
- Select "Install from VSIX..."
|
- Select "Install from VSIX..."
|
||||||
- Choose the generated `.vsix` file
|
- Choose the generated `.vsix` file
|
||||||
|
|
||||||
### 2.4 Creating a Theme
|
### 2.4. Creating a Theme
|
||||||
|
|
||||||
Each theme is defined in a JSON file with the following structure:
|
Each theme is defined in a JSON file with the following structure:
|
||||||
|
|
||||||
@@ -125,8 +125,8 @@ Each theme is defined in a JSON file with the following structure:
|
|||||||
{
|
{
|
||||||
"name": "Theme Name",
|
"name": "Theme Name",
|
||||||
"type": "dark" or "light",
|
"type": "dark" or "light",
|
||||||
"colors": {
|
"colours": {
|
||||||
// UI element colors
|
// UI element colours
|
||||||
},
|
},
|
||||||
"tokenColors": [
|
"tokenColors": [
|
||||||
// Syntax highlighting rules
|
// Syntax highlighting rules
|
||||||
@@ -136,12 +136,12 @@ Each theme is defined in a JSON file with the following structure:
|
|||||||
|
|
||||||
Key sections:
|
Key sections:
|
||||||
|
|
||||||
- **colors**: Defines colors for editor UI elements (background, foreground, sidebar, statusbar, etc.)
|
- **colours**: Defines colours for editor UI elements (background, foreground, sidebar, statusbar, etc.)
|
||||||
- **tokenColors**: Array of rules defining syntax highlighting colors based on TextMate scopes
|
- **tokenColors**: Array of rules defining syntax highlighting colours based on TextMate scopes
|
||||||
|
|
||||||
For example, see `themes/ocean-breeze.json` at lines 1-373.
|
For example, see `themes/ocean-breeze.json` at lines 1-373.
|
||||||
|
|
||||||
### 2.5 Building and Packaging
|
### 2.5. Building and Packaging
|
||||||
|
|
||||||
The package script is configured in `package.json` at lines 38-39:
|
The package script is configured in `package.json` at lines 38-39:
|
||||||
|
|
||||||
@@ -153,11 +153,11 @@ This command:
|
|||||||
- Packages the extension into a `.vsix` file
|
- Packages the extension into a `.vsix` file
|
||||||
- Sets the base content and images URLs to the repository
|
- Sets the base content and images URLs to the repository
|
||||||
|
|
||||||
### 2.6 Publishing
|
### 2.6. Publishing
|
||||||
|
|
||||||
The extension is published by nhcarrigan to the VSCode Marketplace. The publisher configuration is defined in `package.json` at line 10.
|
The extension is published by NHCarrigan to the VSCode Marketplace. The publisher configuration is defined in `package.json` at line 10.
|
||||||
|
|
||||||
### 2.7 Version Management
|
### 2.7. Version Management
|
||||||
|
|
||||||
Current version: 2.2.0 (as defined in `package.json` at line 5)
|
Current version: 2.2.0 (as defined in `package.json` at line 5)
|
||||||
|
|
||||||
@@ -170,15 +170,15 @@ Version history (from git commits):
|
|||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
This section is for expansions to our legal policies specific to the Application.
|
||||||
|
|
||||||
### 3.1 License
|
### 3.1. License
|
||||||
|
|
||||||
The Application is licensed under Naomi Carrigan's global software license, available at: https://docs.nhcarrigan.com/#/license
|
The Application is licensed under Naomi Carrigan's global software licence, available at: https://docs.nhcarrigan.com/#/license
|
||||||
|
|
||||||
Copyright is held by Naomi Carrigan.
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
Reference: `LICENSE.md` at lines 1-5
|
Reference: `LICENSE.md` at lines 1-5
|
||||||
|
|
||||||
### 3.2 Privacy Policy
|
### 3.2. Privacy Policy
|
||||||
|
|
||||||
The Application adheres to the privacy policy documented at: https://docs.nhcarrigan.com/#/privacy
|
The Application adheres to the privacy policy documented at: https://docs.nhcarrigan.com/#/privacy
|
||||||
|
|
||||||
@@ -189,47 +189,47 @@ As a VSCode theme extension, the Application:
|
|||||||
|
|
||||||
Reference: `PRIVACY.md` at lines 1-3
|
Reference: `PRIVACY.md` at lines 1-3
|
||||||
|
|
||||||
### 3.3 Terms of Service
|
### 3.3. Terms of Service
|
||||||
|
|
||||||
The Application is governed by the Terms of Service available at: https://docs.nhcarrigan.com/#/terms
|
The Application is governed by the Terms of Service available at: https://docs.nhcarrigan.com/#/terms
|
||||||
|
|
||||||
Reference: `TERMS.md` at lines 1-3
|
Reference: `TERMS.md` at lines 1-3
|
||||||
|
|
||||||
### 3.4 Security Policy
|
### 3.4. Security Policy
|
||||||
|
|
||||||
Security policies and vulnerability reporting procedures are documented in `SECURITY.md`.
|
Security policies and vulnerability reporting procedures are documented in `SECURITY.md`.
|
||||||
|
|
||||||
### 3.5 Intellectual Property
|
### 3.5. Intellectual Property
|
||||||
|
|
||||||
All themes, color schemes, and design elements are copyright of Naomi Carrigan. The theme names "Ocean Breeze," "Sakura Dreams," and "Trans Pride" are part of this intellectual property.
|
All themes, colour schemes, and design elements are copyright of Naomi Carrigan. The theme names "Ocean Breeze," "Sakura Dreams," and "Trans Pride" are part of this intellectual property.
|
||||||
|
|
||||||
## 4. Contributing Documentation
|
## 4. Contributing Documentation
|
||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
This section is for documentation related to contributing to the Application's codebase.
|
||||||
|
|
||||||
### 4.1 Contributing Guidelines
|
### 4.1. Contributing Guidelines
|
||||||
|
|
||||||
Complete contributing guidelines are available at: https://docs.nhcarrigan.com/#/contributing
|
Complete contributing guidelines are available at: https://docs.nhcarrigan.com/#/contributing
|
||||||
|
|
||||||
Reference: `CONTRIBUTING.md` at lines 1-3
|
Reference: `CONTRIBUTING.md` at lines 1-3
|
||||||
|
|
||||||
### 4.2 Code of Conduct
|
### 4.2. Code of Conduct
|
||||||
|
|
||||||
Before participating in the project, please review the Code of Conduct at: https://git.nhcarrigan.com/nhcarrigan/vscode-themes/src/branch/main/CODE_OF_CONDUCT.md
|
Before participating in the project, please review the Code of Conduct at: https://git.nhcarrigan.com/NHCarrigan/vscode-themes/src/branch/main/CODE_OF_CONDUCT.md
|
||||||
|
|
||||||
The project maintains a welcoming and inclusive environment for all contributors.
|
The project maintains a welcoming and inclusive environment for all contributors.
|
||||||
|
|
||||||
Reference: `README.md` at lines 13-15
|
Reference: `README.md` at lines 13-15
|
||||||
|
|
||||||
### 4.3 How to Contribute
|
### 4.3. How to Contribute
|
||||||
|
|
||||||
#### Reporting Issues
|
#### Reporting Issues
|
||||||
|
|
||||||
1. Check existing issues at: https://git.nhcarrigan.com/nhcarrigan/vscode-themes/issues
|
1. Check existing posts in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
2. Create a new issue with:
|
2. Post in the appropriate forum channel with:
|
||||||
- Clear description of the problem or suggestion
|
- Clear description of the problem or suggestion
|
||||||
- Steps to reproduce (for bugs)
|
- Steps to reproduce (for bugs)
|
||||||
- Expected vs. actual behavior
|
- Expected vs. actual behaviour
|
||||||
- VSCode version and operating system
|
- VSCode version and operating system
|
||||||
|
|
||||||
#### Submitting Pull Requests
|
#### Submitting Pull Requests
|
||||||
@@ -250,7 +250,7 @@ Reference: `README.md` at lines 13-15
|
|||||||
When contributing a new theme:
|
When contributing a new theme:
|
||||||
|
|
||||||
1. Ensure the theme has a unique name and aesthetic
|
1. Ensure the theme has a unique name and aesthetic
|
||||||
2. Define both `colors` and `tokenColors` sections comprehensively
|
2. Define both `colours` and `tokenColors` sections comprehensively
|
||||||
3. Test the theme with multiple programming languages
|
3. Test the theme with multiple programming languages
|
||||||
4. Ensure sufficient contrast for accessibility
|
4. Ensure sufficient contrast for accessibility
|
||||||
5. Add the theme entry to `package.json` under `contributes.themes`
|
5. Add the theme entry to `package.json` under `contributes.themes`
|
||||||
@@ -268,7 +268,7 @@ Example theme entry in `package.json`:
|
|||||||
|
|
||||||
Reference: `package.json` at lines 14-36
|
Reference: `package.json` at lines 14-36
|
||||||
|
|
||||||
### 4.4 Development Standards
|
### 4.4. Development Standards
|
||||||
|
|
||||||
#### File Naming Conventions
|
#### File Naming Conventions
|
||||||
|
|
||||||
@@ -283,12 +283,12 @@ Reference: `package.json` at lines 14-36
|
|||||||
|
|
||||||
#### Color Guidelines
|
#### Color Guidelines
|
||||||
|
|
||||||
- Use hex color codes (e.g., `#012a22`)
|
- Use hex colour codes (e.g., `#012a22`)
|
||||||
- Consider accessibility and contrast ratios
|
- Consider accessibility and contrast ratios
|
||||||
- Test colors in both day and night lighting conditions
|
- Test colours in both day and night lighting conditions
|
||||||
- Document color inspiration or theme concept if applicable
|
- Document colour inspiration or theme concept if applicable
|
||||||
|
|
||||||
### 4.5 Testing
|
### 4.5. Testing
|
||||||
|
|
||||||
Before submitting:
|
Before submitting:
|
||||||
|
|
||||||
@@ -301,9 +301,9 @@ Before submitting:
|
|||||||
- HTML/CSS
|
- HTML/CSS
|
||||||
- Markdown
|
- Markdown
|
||||||
4. Verify UI elements (sidebar, statusbar, tabs, etc.) are properly styled
|
4. Verify UI elements (sidebar, statusbar, tabs, etc.) are properly styled
|
||||||
5. Check for color contrast issues
|
5. Check for colour contrast issues
|
||||||
|
|
||||||
### 4.6 Release Process
|
### 4.6. Release Process
|
||||||
|
|
||||||
Releases are managed by the project maintainer (Naomi Carrigan). The typical release process:
|
Releases are managed by the project maintainer (Naomi Carrigan). The typical release process:
|
||||||
|
|
||||||
@@ -318,13 +318,13 @@ Recent release pattern (from git history):
|
|||||||
- Releases are tagged in git
|
- Releases are tagged in git
|
||||||
- Each release includes descriptive commit messages
|
- Each release includes descriptive commit messages
|
||||||
|
|
||||||
### 4.7 Community and Communication
|
### 4.7. Community and Communication
|
||||||
|
|
||||||
- Issues and discussions: https://git.nhcarrigan.com/nhcarrigan/vscode-themes/issues
|
- Issues and discussions: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- Chat Server: http://chat.nhcarrigan.com
|
- Chat Server: https://chat.nhcarrigan.com
|
||||||
- Email: contact@nhcarrigan.com
|
- Email: contact@nhcarrigan.com
|
||||||
- Homepage: https://nhcarrigan.com
|
- Homepage: https://nhcarrigan.com
|
||||||
|
|
||||||
### 4.8 Recognition
|
### 4.8. Recognition
|
||||||
|
|
||||||
Contributors are valued members of the project. Significant contributions may be recognized in release notes or project documentation.
|
Contributors are valued members of the project. Significant contributions may be recognised in release notes or project documentation.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Website Headers
|
title: Website Headers
|
||||||
---
|
---
|
||||||
|
|
||||||
Website Headers (hereinafter the "Application") is a JavaScript/TypeScript library that injects standardized metadata, styles, and UI components (such as footers and modals) into web pages. It is designed to provide consistent branding, accessibility, and legal compliance for Naomi Carrigan's web properties. The Application dynamically adds Open Graph and Twitter meta tags, favicons, global styles, a themed footer, analytics scripts, and a community call-to-action modal. It also supports theme toggling and audio playback for enhanced user experience.
|
Website Headers (hereinafter the "Application") is a JavaScript/TypeScript library that injects standardised metadata, styles, and UI components (such as footers and modals) into web pages. It is designed to provide consistent branding, accessibility, and legal compliance for Naomi Carrigan's web properties. The Application dynamically adds Open Graph and Twitter meta tags, favicons, global styles, a themed footer, analytics scripts, and a community call-to-action modal. It also supports theme toggling and audio playback for enhanced user experience.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ The Website Headers library automatically enhances any webpage by injecting:
|
|||||||
- **Responsive design**: Mobile-friendly layout with adaptive footer
|
- **Responsive design**: Mobile-friendly layout with adaptive footer
|
||||||
- **Theme persistence**: Remembers user's theme preference across sessions
|
- **Theme persistence**: Remembers user's theme preference across sessions
|
||||||
- **Privacy-respecting**: Uses privacy-focused Plausible Analytics
|
- **Privacy-respecting**: Uses privacy-focused Plausible Analytics
|
||||||
- **Performance optimized**: Minified production build with deferred script loading
|
- **Performance optimised**: Minified production build with deferred script loading
|
||||||
- **Cross-platform**: Works on all modern browsers and devices
|
- **Cross-platform**: Works on all modern browsers and devices
|
||||||
|
|
||||||
### Integration
|
### Integration
|
||||||
@@ -152,7 +152,7 @@ The library loads several external resources:
|
|||||||
|
|
||||||
### Licensing
|
### Licensing
|
||||||
|
|
||||||
This software is licensed under [Naomi's Public License](https://docs.nhcarrigan.com/legal/license).
|
This software is licensed under [Naomi's Public Licence](https://docs.nhcarrigan.com/legal/license).
|
||||||
|
|
||||||
**Copyright Notice**: Copyright held by Naomi Carrigan.
|
**Copyright Notice**: Copyright held by Naomi Carrigan.
|
||||||
|
|
||||||
@@ -169,7 +169,7 @@ The Application integrates with several third-party services that have their own
|
|||||||
#### Advertising
|
#### Advertising
|
||||||
- **Google AdSense**: Contextual advertising platform
|
- **Google AdSense**: Contextual advertising platform
|
||||||
- Client ID: `ca-pub-3569924701890974`
|
- Client ID: `ca-pub-3569924701890974`
|
||||||
- May collect user data for ad personalization
|
- May collect user data for ad personalisation
|
||||||
- Privacy policy: [Google Privacy Policy](https://policies.google.com/privacy)
|
- Privacy policy: [Google Privacy Policy](https://policies.google.com/privacy)
|
||||||
|
|
||||||
#### Environmental Impact
|
#### Environmental Impact
|
||||||
@@ -188,7 +188,7 @@ The Application integrates with several third-party services that have their own
|
|||||||
|
|
||||||
#### Local Storage Usage
|
#### Local Storage Usage
|
||||||
The Application stores the following data in the user's browser:
|
The Application stores the following data in the user's browser:
|
||||||
- `theme`: User's preferred color scheme (light/dark)
|
- `theme`: User's preferred colour scheme (light/dark)
|
||||||
- `naomi-community-cta`: Timestamp of last community modal display
|
- `naomi-community-cta`: Timestamp of last community modal display
|
||||||
|
|
||||||
#### External Resource Loading
|
#### External Resource Loading
|
||||||
@@ -210,7 +210,7 @@ Organizations using this library should be aware that it:
|
|||||||
|
|
||||||
For legal inquiries regarding this Application:
|
For legal inquiries regarding this Application:
|
||||||
- Email: `contact@nhcarrigan.com`
|
- Email: `contact@nhcarrigan.com`
|
||||||
- Community: [Chat Server](http://chat.nhcarrigan.com)
|
- Community: [Chat Server](https://chat.nhcarrigan.com)
|
||||||
|
|
||||||
## 4. Contributing Documentation
|
## 4. Contributing Documentation
|
||||||
|
|
||||||
@@ -251,7 +251,7 @@ We welcome contributions to the website-headers project! Please review our [cont
|
|||||||
- **ESLint**: Code must pass all linting rules (`@nhcarrigan/eslint-config`)
|
- **ESLint**: Code must pass all linting rules (`@nhcarrigan/eslint-config`)
|
||||||
- **No warnings**: Build process fails if ESLint warnings are present
|
- **No warnings**: Build process fails if ESLint warnings are present
|
||||||
- **Comments**: Use JSDoc comments for functions and complex logic
|
- **Comments**: Use JSDoc comments for functions and complex logic
|
||||||
- **Accessibility**: Maintain accessibility features (fonts, colors, ARIA labels)
|
- **Accessibility**: Maintain accessibility features (fonts, colours, ARIA labels)
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ We welcome contributions to the website-headers project! Please review our [cont
|
|||||||
### Areas for Contribution
|
### Areas for Contribution
|
||||||
|
|
||||||
#### High Priority
|
#### High Priority
|
||||||
- **Performance optimization**: Reduce bundle size, optimize loading
|
- **Performance optimisation**: Reduce bundle size, optimise loading
|
||||||
- **Accessibility improvements**: Enhanced ARIA support, keyboard navigation
|
- **Accessibility improvements**: Enhanced ARIA support, keyboard navigation
|
||||||
- **Mobile experience**: Better responsive design, touch interactions
|
- **Mobile experience**: Better responsive design, touch interactions
|
||||||
- **Browser compatibility**: Support for older browsers
|
- **Browser compatibility**: Support for older browsers
|
||||||
@@ -272,10 +272,10 @@ We welcome contributions to the website-headers project! Please review our [cont
|
|||||||
- **Documentation**: Improve inline code documentation
|
- **Documentation**: Improve inline code documentation
|
||||||
- **Error handling**: Add graceful fallbacks for external resource failures
|
- **Error handling**: Add graceful fallbacks for external resource failures
|
||||||
- **Testing framework**: Implement automated testing
|
- **Testing framework**: Implement automated testing
|
||||||
- **Configuration options**: Make the library more customizable
|
- **Configuration options**: Make the library more customisable
|
||||||
|
|
||||||
#### Low Priority
|
#### Low Priority
|
||||||
- **Additional themes**: More color scheme options
|
- **Additional themes**: More colour scheme options
|
||||||
- **Animation effects**: Subtle transitions and animations
|
- **Animation effects**: Subtle transitions and animations
|
||||||
- **Internationalization**: Multi-language support
|
- **Internationalization**: Multi-language support
|
||||||
- **Advanced analytics**: More detailed event tracking
|
- **Advanced analytics**: More detailed event tracking
|
||||||
@@ -306,14 +306,14 @@ We welcome contributions to the website-headers project! Please review our [cont
|
|||||||
|
|
||||||
### Getting Help
|
### Getting Help
|
||||||
|
|
||||||
- **Issues**: Open a GitHub issue for bugs or feature requests
|
- **Issues**: Post in the #bug-reports or #feature-requests forum channels on our Discord community
|
||||||
- **Discussions**: Use GitHub Discussions for questions and ideas
|
- **Discussions**: Use Gitea discussions for questions and ideas
|
||||||
- **Community**: Join our [chat server](http://chat.nhcarrigan.com) for real-time help
|
- **Community**: Join our [chat server](https://chat.nhcarrigan.com) for real-time help
|
||||||
- **Email**: Contact us at `contact@nhcarrigan.com` for private inquiries
|
- **Email**: Contact us at `contact@nhcarrigan.com` for private inquiries
|
||||||
|
|
||||||
### Recognition
|
### Recognition
|
||||||
|
|
||||||
Contributors will be recognized in:
|
Contributors will be recognised in:
|
||||||
- Git commit history
|
- Git commit history
|
||||||
- Release notes
|
- Release notes
|
||||||
- Project documentation
|
- Project documentation
|
||||||
|
|||||||
@@ -4,17 +4,17 @@ title: Join Our Volunteer Team
|
|||||||
|
|
||||||
## 1. Volunteer Service Framework
|
## 1. Volunteer Service Framework
|
||||||
|
|
||||||
### 1.1 Volunteer Position Nature
|
### 1.1. Volunteer Position Nature
|
||||||
|
|
||||||
Unless explicitly stated otherwise in a separate written agreement, all positions within our organisation are provided on a voluntary basis. No compensation, monetary or otherwise, should be expected for these roles.
|
Unless explicitly stated otherwise in a separate written agreement, all positions within our organisation are provided on a voluntary basis. No compensation, monetary or otherwise, should be expected for these roles.
|
||||||
|
|
||||||
### 1.2 Service Philosophy
|
### 1.2. Service Philosophy
|
||||||
|
|
||||||
Our volunteer program operates on servant leadership principles, emphasising service to the community, professional development opportunities, and meaningful contribution to creating inclusive online environments. All volunteer service operates within our comprehensive legal and policy framework.
|
Our volunteer programme operates on servant leadership principles, emphasising service to the community, professional development opportunities, and meaningful contribution to creating inclusive online environments. All volunteer service operates within our comprehensive legal and policy framework.
|
||||||
|
|
||||||
## 2. Available Volunteer Opportunities
|
## 2. Available Volunteer Opportunities
|
||||||
|
|
||||||
### 2.1 Leadership Positions
|
### 2.1. Leadership Positions
|
||||||
|
|
||||||
We offer volunteer opportunities across multiple leadership levels:
|
We offer volunteer opportunities across multiple leadership levels:
|
||||||
|
|
||||||
@@ -26,20 +26,20 @@ We offer volunteer opportunities across multiple leadership levels:
|
|||||||
|
|
||||||
**(d)** **Community Leadership**: Front-line community support and member assistance (Moderators, Mentors, Subject Matter Experts, Technical Contributors).
|
**(d)** **Community Leadership**: Front-line community support and member assistance (Moderators, Mentors, Subject Matter Experts, Technical Contributors).
|
||||||
|
|
||||||
### 2.2 Comprehensive Role Information
|
### 2.2. Comprehensive Role Information
|
||||||
|
|
||||||
**For detailed information about specific volunteer roles, responsibilities, qualifications, and selection criteria, please review our [Volunteer Roles and Opportunities documentation](/staff/roles).**
|
**For detailed information about specific volunteer roles, responsibilities, qualifications, and selection criteria, please review our [Volunteer Roles and Opportunities documentation](/staff/roles).**
|
||||||
|
|
||||||
## 3. Application Process and Selection
|
## 3. Application Process and Selection
|
||||||
|
|
||||||
### 3.1 Universal Selection Criteria
|
### 3.1. Universal Selection Criteria
|
||||||
|
|
||||||
All volunteer positions require:
|
All volunteer positions require:
|
||||||
- Clean disciplinary record with no serious policy violations
|
- Clean disciplinary record with no serious policy violations
|
||||||
- Demonstrated commitment to community values and inclusive principles
|
- Demonstrated commitment to community values and inclusive principles
|
||||||
- Reliable availability and strong collaborative communication skills
|
- Reliable availability and strong collaborative communication skills
|
||||||
|
|
||||||
### 3.2 Application Submission
|
### 3.2. Application Submission
|
||||||
|
|
||||||
**Ready to Apply?** Complete our comprehensive application form: [**Volunteer Application Form**](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8)
|
**Ready to Apply?** Complete our comprehensive application form: [**Volunteer Application Form**](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8)
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ All volunteer positions require:
|
|||||||
- Specification of preferred volunteer roles and availability commitments
|
- Specification of preferred volunteer roles and availability commitments
|
||||||
- Acknowledgement of policy framework compliance requirements
|
- Acknowledgement of policy framework compliance requirements
|
||||||
|
|
||||||
### 3.3 Selection and Onboarding Process
|
### 3.3. Selection and Onboarding Process
|
||||||
|
|
||||||
**Selection Timeline:**
|
**Selection Timeline:**
|
||||||
1. **Application Review**: Diverse selection committee evaluation including community representation
|
1. **Application Review**: Diverse selection committee evaluation including community representation
|
||||||
@@ -57,31 +57,31 @@ All volunteer positions require:
|
|||||||
|
|
||||||
**New Volunteer Integration:**
|
**New Volunteer Integration:**
|
||||||
- Comprehensive orientation including community values and policy framework training
|
- Comprehensive orientation including community values and policy framework training
|
||||||
- Role-specific training and competency development programs
|
- Role-specific training and competency development programmes
|
||||||
- Mentorship assignment with experienced volunteers for ongoing support
|
- Mentorship assignment with experienced volunteers for ongoing support
|
||||||
- Progressive responsibility integration with regular check-ins and feedback
|
- Progressive responsibility integration with regular check-ins and feedback
|
||||||
|
|
||||||
## 4. Volunteer Support and Development
|
## 4. Volunteer Support and Development
|
||||||
|
|
||||||
### 4.1 Professional Development Opportunities
|
### 4.1. Professional Development Opportunities
|
||||||
|
|
||||||
All volunteers receive access to:
|
All volunteers receive access to:
|
||||||
- Leadership coaching and mentorship programs
|
- Leadership coaching and mentorship programmes
|
||||||
- External training and conference attendance support
|
- External training and conference attendance support
|
||||||
- Cross-functional experience and advancement opportunities
|
- Cross-functional experience and advancement opportunities
|
||||||
- Professional development resources and networking opportunities
|
- Professional development resources and networking opportunities
|
||||||
|
|
||||||
### 4.2 Recognition and Wellness Support
|
### 4.2. Recognition and Wellness Support
|
||||||
|
|
||||||
**Comprehensive Support Systems:**
|
**Comprehensive Support Systems:**
|
||||||
- Regular recognition and appreciation programs celebrating volunteer contributions
|
- Regular recognition and appreciation programmes celebrating volunteer contributions
|
||||||
- Mental health resources and peer support networks
|
- Mental health resources and peer support networks
|
||||||
- Flexible volunteer arrangements accommodating life circumstances
|
- Flexible volunteer arrangements accommodating life circumstances
|
||||||
- Clear role boundaries and burnout prevention resources
|
- Clear role boundaries and burnout prevention resources
|
||||||
|
|
||||||
## 5. Legal Framework and Policy Compliance
|
## 5. Legal Framework and Policy Compliance
|
||||||
|
|
||||||
### 5.1 Comprehensive Policy Integration
|
### 5.1. Comprehensive Policy Integration
|
||||||
|
|
||||||
All volunteers must understand and comply with our complete legal and policy framework:
|
All volunteers must understand and comply with our complete legal and policy framework:
|
||||||
|
|
||||||
@@ -95,11 +95,11 @@ All volunteers must understand and comply with our complete legal and policy fra
|
|||||||
|
|
||||||
**(e)** **All Legal and Community Policies**: Privacy protection, acceptable use, recognition systems, and democratic participation frameworks.
|
**(e)** **All Legal and Community Policies**: Privacy protection, acceptable use, recognition systems, and democratic participation frameworks.
|
||||||
|
|
||||||
### 5.2 Legal Disclaimer and Volunteer Acknowledgement
|
### 5.2. Legal Disclaimer and Volunteer Acknowledgement
|
||||||
|
|
||||||
**IMPORTANT LEGAL NOTICE:**
|
**IMPORTANT LEGAL NOTICE:**
|
||||||
|
|
||||||
This document does not constitute an offer of employment or create a binding employment contract. Our organisation reserves the right to modify, suspend, or terminate any volunteer position or associated programs at any time, without prior notice.
|
This document does not constitute an offer of employment or create a binding employment contract. Our organisation reserves the right to modify, suspend, or terminate any volunteer position or associated programmes at any time, without prior notice.
|
||||||
|
|
||||||
**Volunteer Service Acknowledgement:**
|
**Volunteer Service Acknowledgement:**
|
||||||
|
|
||||||
@@ -117,14 +117,14 @@ By engaging in any volunteer activities, you explicitly acknowledge that you hav
|
|||||||
|
|
||||||
## 6. Questions and Support
|
## 6. Questions and Support
|
||||||
|
|
||||||
### 6.1 Getting Started
|
### 6.1. Getting Started
|
||||||
|
|
||||||
**Questions About Volunteer Opportunities?**
|
**Questions About Volunteer Opportunities?**
|
||||||
- Review our comprehensive [Volunteer Roles and Opportunities](/staff/roles) documentation
|
- Review our comprehensive [Volunteer Roles and Opportunities](/staff/roles) documentation
|
||||||
- Contact our Community Leaders through Discord for specific questions
|
- Contact our Community Leaders through Discord for specific questions
|
||||||
- Participate in community activities to gain familiarity with our values and culture before applying
|
- Participate in community activities to gain familiarity with our values and culture before applying
|
||||||
|
|
||||||
### 6.2 Application Support
|
### 6.2. Application Support
|
||||||
|
|
||||||
**Need Help with Your Application?**
|
**Need Help with Your Application?**
|
||||||
- Community Leaders are available to discuss volunteer opportunities and application processes
|
- Community Leaders are available to discuss volunteer opportunities and application processes
|
||||||
@@ -135,10 +135,10 @@ By engaging in any volunteer activities, you explicitly acknowledge that you hav
|
|||||||
|
|
||||||
## Commitment to Volunteer Excellence
|
## Commitment to Volunteer Excellence
|
||||||
|
|
||||||
We are committed to providing exceptional volunteer experiences that contribute to both personal development and meaningful community impact. Through comprehensive support systems, professional development opportunities, and recognition programs, we ensure that volunteer service is rewarding, sustainable, and aligned with our mission of creating inclusive online environments.
|
We are committed to providing exceptional volunteer experiences that contribute to both personal development and meaningful community impact. Through comprehensive support systems, professional development opportunities, and recognition programmes, we ensure that volunteer service is rewarding, sustainable, and aligned with our mission of creating inclusive online environments.
|
||||||
|
|
||||||
Your interest in volunteering with our organisation demonstrates commitment to community service and inclusive values that we deeply appreciate. We look forward to reviewing your application and potentially welcoming you to our volunteer team.
|
Your interest in volunteering with our organisation demonstrates commitment to community service and inclusive values that we deeply appreciate. We look forward to reviewing your application and potentially welcoming you to our volunteer team.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This volunteer application information was last updated on 15 September 2025. For questions about volunteer opportunities, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
*This volunteer application information. For questions about volunteer opportunities, please contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Welcome to our organisation. This Staff Handbook serves as a comprehensive guide
|
|||||||
|
|
||||||
**(b)** **Community Leadership and Governance Policy**: Leadership structure, accountability, and governance frameworks;
|
**(b)** **Community Leadership and Governance Policy**: Leadership structure, accountability, and governance frameworks;
|
||||||
|
|
||||||
**(c)** **Community Recognition and Appreciation Policy**: Recognition systems and volunteer support programs;
|
**(c)** **Community Recognition and Appreciation Policy**: Recognition systems and volunteer support programmes;
|
||||||
|
|
||||||
**(d)** **Community Feedback and Participation Policy**: Democratic participation and community input processes;
|
**(d)** **Community Feedback and Participation Policy**: Democratic participation and community input processes;
|
||||||
|
|
||||||
@@ -28,18 +28,18 @@ By familiarising yourself with this handbook and our broader policy framework, y
|
|||||||
|
|
||||||
## 1. Activity Requirements
|
## 1. Activity Requirements
|
||||||
|
|
||||||
### 1.1 Flexible Engagement
|
### 1.1. Flexible Engagement
|
||||||
|
|
||||||
We recognize and deeply appreciate that our staff members are volunteers dedicating their time and effort to support our community. As such, we do not impose rigid activity quotas or specific engagement levels.
|
We recognise and deeply appreciate that our staff members are volunteers dedicating their time and effort to support our community. As such, we do not impose rigid activity quotas or specific engagement levels.
|
||||||
|
|
||||||
### 1.2 Communication of Extended Absences
|
### 1.2. Communication of Extended Absences
|
||||||
|
|
||||||
While we maintain a flexible approach to activity, we kindly request that you inform us of any anticipated absences:
|
While we maintain a flexible approach to activity, we kindly request that you inform us of any anticipated absences:
|
||||||
|
|
||||||
- For absences exceeding one week, please notify the team via the `#staff-chat` channel on Discord.
|
- For absences exceeding one week, please notify the team via the `#staff-chat` channel on Discord.
|
||||||
- This communication helps us manage workload distribution and ensures continued smooth operation of our community.
|
- This communication helps us manage workload distribution and ensures continued smooth operation of our community.
|
||||||
|
|
||||||
### 1.3 Extended Inactivity
|
### 1.3. Extended Inactivity
|
||||||
|
|
||||||
In cases of prolonged inactivity:
|
In cases of prolonged inactivity:
|
||||||
|
|
||||||
@@ -47,40 +47,40 @@ In cases of prolonged inactivity:
|
|||||||
- This policy helps maintain an engaged and responsive staff roster.
|
- This policy helps maintain an engaged and responsive staff roster.
|
||||||
- Please note that removal due to inactivity is not punitive and does not reflect negatively on your contributions.
|
- Please note that removal due to inactivity is not punitive and does not reflect negatively on your contributions.
|
||||||
|
|
||||||
### 1.4 Returning to the Team
|
### 1.4. Returning to the Team
|
||||||
|
|
||||||
We value your contributions and understand that life circumstances can change:
|
We value your contributions and understand that life circumstances can change:
|
||||||
|
|
||||||
- If you've been removed due to inactivity, you are always welcome to rejoin the staff team when your schedule permits.
|
- If you've been removed due to inactivity, you are always welcome to rejoin the staff team when your schedule permits.
|
||||||
- To rejoin, please contact an admin.
|
- To rejoin, please contact an admin.
|
||||||
|
|
||||||
### 1.5 Balancing Commitments
|
### 1.5. Balancing Commitments
|
||||||
|
|
||||||
We encourage you to balance your volunteer work with your personal life and other commitments:
|
We encourage you to balance your volunteer work with your personal life and other commitments:
|
||||||
|
|
||||||
- Your well-being is important to us. Never feel pressured to overextend yourself.
|
- Your well-being is important to us. Never feel pressured to overextend yourself.
|
||||||
- If you find your role becoming stressful or overly time-consuming, please discuss this with an admin.
|
- If you find your role becoming stressful or overly time-consuming, please discuss this with an admin.
|
||||||
|
|
||||||
### 1.6 Recognition and Appreciation
|
### 1.6. Recognition and Appreciation
|
||||||
|
|
||||||
**Reference to Comprehensive Recognition Framework**: Detailed volunteer recognition, appreciation programs, and wellness support systems are set forth in our Community Recognition and Appreciation Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Recognition Framework**: Detailed volunteer recognition, appreciation programmes, and wellness support systems are set forth in our Community Recognition and Appreciation Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
Key recognition elements include:
|
Key recognition elements include:
|
||||||
- Regular appreciation and acknowledgement of volunteer contributions
|
- Regular appreciation and acknowledgement of volunteer contributions
|
||||||
- Volunteer milestone recognition and celebration programs
|
- Volunteer milestone recognition and celebration programmes
|
||||||
- Burnout prevention resources and wellness support systems
|
- Burnout prevention resources and wellness support systems
|
||||||
- Professional development opportunities and growth support
|
- Professional development opportunities and growth support
|
||||||
- Flexible volunteer arrangements accommodating personal circumstances
|
- Flexible volunteer arrangements accommodating personal circumstances
|
||||||
|
|
||||||
## 2. Staff Roles and Leadership Framework
|
## 2. Staff Roles and Leadership Framework
|
||||||
|
|
||||||
### 2.1 Leadership Structure Integration
|
### 2.1. Leadership Structure Integration
|
||||||
|
|
||||||
**Reference to Comprehensive Leadership Framework**: Detailed leadership roles, responsibilities, selection processes, and accountability mechanisms are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Leadership Framework**: Detailed leadership roles, responsibilities, selection processes, and accountability mechanisms are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
Our community leadership operates through a structured hierarchy, outlined in [a diagram](/staff/hierarchy).
|
Our community leadership operates through a structured hierarchy, outlined in [a diagram](/staff/hierarchy).
|
||||||
|
|
||||||
### 2.2 Staff Role Definition and Principles
|
### 2.2. Staff Role Definition and Principles
|
||||||
|
|
||||||
As a staff member, you occupy a position of trust within our community operating under the servant leadership principle. All staff roles come with responsibilities and tools to ensure the safety and well-being of our community members. Key principles:
|
As a staff member, you occupy a position of trust within our community operating under the servant leadership principle. All staff roles come with responsibilities and tools to ensure the safety and well-being of our community members. Key principles:
|
||||||
|
|
||||||
@@ -89,9 +89,9 @@ As a staff member, you occupy a position of trust within our community operating
|
|||||||
- You serve the community rather than wielding authority for personal benefit
|
- You serve the community rather than wielding authority for personal benefit
|
||||||
- You are accountable to the community you serve through established accountability mechanisms
|
- You are accountable to the community you serve through established accountability mechanisms
|
||||||
|
|
||||||
### 2.3 General Staff Expectations
|
### 2.3. General Staff Expectations
|
||||||
|
|
||||||
#### 2.3.1 Leading by Example
|
#### 2.3.1. Leading by Example
|
||||||
|
|
||||||
As staff members, you are expected to exemplify the ideal community member:
|
As staff members, you are expected to exemplify the ideal community member:
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ As staff members, you are expected to exemplify the ideal community member:
|
|||||||
- Demonstrate a welcoming and inclusive attitude towards all members, especially newcomers
|
- Demonstrate a welcoming and inclusive attitude towards all members, especially newcomers
|
||||||
- Model the behaviour and values we want to see throughout the community
|
- Model the behaviour and values we want to see throughout the community
|
||||||
|
|
||||||
#### 2.3.2 Balancing Roles and Responsibilities
|
#### 2.3.2. Balancing Roles and Responsibilities
|
||||||
|
|
||||||
Remember that you are both a staff member and a community member:
|
Remember that you are both a staff member and a community member:
|
||||||
|
|
||||||
@@ -109,7 +109,7 @@ Remember that you are both a staff member and a community member:
|
|||||||
- Maintain a balance between your staff duties and personal enjoyment within the community
|
- Maintain a balance between your staff duties and personal enjoyment within the community
|
||||||
- Recognise when situations require your staff expertise versus when you can participate as a regular member
|
- Recognise when situations require your staff expertise versus when you can participate as a regular member
|
||||||
|
|
||||||
#### 2.3.3 Platform Familiarity and Cross-Platform Coordination
|
#### 2.3.3. Platform Familiarity and Cross-Platform Coordination
|
||||||
|
|
||||||
Our community spans multiple platforms with coordinated governance:
|
Our community spans multiple platforms with coordinated governance:
|
||||||
|
|
||||||
@@ -118,11 +118,11 @@ Our community spans multiple platforms with coordinated governance:
|
|||||||
- Seek assistance or guidance from fellow staff members and leadership when dealing with unfamiliar situations
|
- Seek assistance or guidance from fellow staff members and leadership when dealing with unfamiliar situations
|
||||||
- Coordinate with other platform teams to ensure cohesive community experience
|
- Coordinate with other platform teams to ensure cohesive community experience
|
||||||
|
|
||||||
### 2.4 Staff Standards and Accountability
|
### 2.4. Staff Standards and Accountability
|
||||||
|
|
||||||
**Reference to Comprehensive Standards Framework**: Detailed performance standards, accountability mechanisms, and oversight procedures are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Standards Framework**: Detailed performance standards, accountability mechanisms, and oversight procedures are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
#### 2.4.1 Professional Conduct and Community Values
|
#### 2.4.1. Professional Conduct and Community Values
|
||||||
|
|
||||||
Maintain exemplary conduct aligned with our community values:
|
Maintain exemplary conduct aligned with our community values:
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ Maintain exemplary conduct aligned with our community values:
|
|||||||
- Model the behaviour expected of all community members whilst serving in your staff capacity
|
- Model the behaviour expected of all community members whilst serving in your staff capacity
|
||||||
- Use appropriate, inclusive language and maintain trauma-informed practices
|
- Use appropriate, inclusive language and maintain trauma-informed practices
|
||||||
|
|
||||||
#### 2.4.2 Fairness, Consistency, and Evidence-Based Decision-Making
|
#### 2.4.2. Fairness, Consistency, and Evidence-Based Decision-Making
|
||||||
|
|
||||||
Apply policies and take actions consistently following established frameworks:
|
Apply policies and take actions consistently following established frameworks:
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ Apply policies and take actions consistently following established frameworks:
|
|||||||
- Follow progressive disciplinary frameworks and restorative justice principles when appropriate
|
- Follow progressive disciplinary frameworks and restorative justice principles when appropriate
|
||||||
- Consider cultural sensitivity and accessibility needs in all staff decisions and actions
|
- Consider cultural sensitivity and accessibility needs in all staff decisions and actions
|
||||||
|
|
||||||
#### 2.4.3 Transparency and Community Accountability
|
#### 2.4.3. Transparency and Community Accountability
|
||||||
|
|
||||||
Maintain transparency and accountability to the community:
|
Maintain transparency and accountability to the community:
|
||||||
|
|
||||||
@@ -149,9 +149,9 @@ Maintain transparency and accountability to the community:
|
|||||||
- Participate in community feedback systems and performance review processes
|
- Participate in community feedback systems and performance review processes
|
||||||
- Be responsive to community input and concerns about staff effectiveness
|
- Be responsive to community input and concerns about staff effectiveness
|
||||||
|
|
||||||
### 2.5 Collaboration and Support
|
### 2.5. Collaboration and Support
|
||||||
|
|
||||||
#### 2.5.1 Team Communication
|
#### 2.5.1. Team Communication
|
||||||
|
|
||||||
Maintain open lines of communication with your fellow staff members:
|
Maintain open lines of communication with your fellow staff members:
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ Maintain open lines of communication with your fellow staff members:
|
|||||||
- Share experiences and seek advice when facing challenging situations
|
- Share experiences and seek advice when facing challenging situations
|
||||||
- Communicate openly about workload, availability, and support needs
|
- Communicate openly about workload, availability, and support needs
|
||||||
|
|
||||||
#### 2.5.2 Continuous Learning and Development
|
#### 2.5.2. Continuous Learning and Development
|
||||||
|
|
||||||
Stay informed and improve your skills:
|
Stay informed and improve your skills:
|
||||||
|
|
||||||
@@ -167,7 +167,7 @@ Stay informed and improve your skills:
|
|||||||
- Participate in provided training, skill-sharing sessions, and professional development opportunities
|
- Participate in provided training, skill-sharing sessions, and professional development opportunities
|
||||||
- Seek feedback from peers and leadership to continuously improve your effectiveness
|
- Seek feedback from peers and leadership to continuously improve your effectiveness
|
||||||
|
|
||||||
#### 2.5.3 Escalation Protocol
|
#### 2.5.3. Escalation Protocol
|
||||||
|
|
||||||
Know when and how to escalate issues:
|
Know when and how to escalate issues:
|
||||||
|
|
||||||
@@ -175,32 +175,32 @@ Know when and how to escalate issues:
|
|||||||
- Follow established procedures for escalating complex, sensitive, or high-impact matters
|
- Follow established procedures for escalating complex, sensitive, or high-impact matters
|
||||||
- Understand the scope of your role and when issues exceed your authority or expertise
|
- Understand the scope of your role and when issues exceed your authority or expertise
|
||||||
|
|
||||||
### 2.6 Documentation and Transparency
|
### 2.6. Documentation and Transparency
|
||||||
|
|
||||||
**Reference to Comprehensive Frameworks**: Detailed procedures, documentation requirements, and transparency systems are set forth in our Content and Moderation Policy and Community Leadership and Governance Policy, which are incorporated herein by reference.
|
**Reference to Comprehensive Frameworks**: Detailed procedures, documentation requirements, and transparency systems are set forth in our Content and Moderation Policy and Community Leadership and Governance Policy, which are incorporated herein by reference.
|
||||||
|
|
||||||
#### 2.6.1 Action Documentation Requirements
|
#### 2.6.1. Action Documentation Requirements
|
||||||
- All significant staff actions must be documented appropriately for transparency and consistency
|
- All significant staff actions must be documented appropriately for transparency and consistency
|
||||||
- Staff in moderation roles must log actions via our API system
|
- Staff in moderation roles must log actions via our API system
|
||||||
- Documentation maintained in our public transparency system at [hikari.nhcarrigan.com/sanctions](https://hikari.nhcarrigan.com/sanctions) where applicable
|
- Documentation maintained in our public transparency system at [hikari.nhcarrigan.com/sanctions](https://hikari.nhcarrigan.com/sanctions) where applicable
|
||||||
- Privacy protection measures ensure appropriate balance between transparency and confidentiality
|
- Privacy protection measures ensure appropriate balance between transparency and confidentiality
|
||||||
- Regular documentation review for quality assurance and consistency improvement
|
- Regular documentation review for quality assurance and consistency improvement
|
||||||
|
|
||||||
#### 2.6.2 Access and Training
|
#### 2.6.2. Access and Training
|
||||||
- System access provided based on role requirements (contact leadership team for setup)
|
- System access provided based on role requirements (contact leadership team for setup)
|
||||||
- Training provided on relevant documentation systems and transparency requirements
|
- Training provided on relevant documentation systems and transparency requirements
|
||||||
- Ongoing support available for technical and procedural questions related to your specific role
|
- Ongoing support available for technical and procedural questions related to your specific role
|
||||||
|
|
||||||
## 3. Working With Fellow Staff Members
|
## 3. Working With Fellow Staff Members
|
||||||
|
|
||||||
### 3.1 Communication Channels
|
### 3.1. Communication Channels
|
||||||
|
|
||||||
#### 3.1.1 Primary Communication Platforms
|
#### 3.1.1. Primary Communication Platforms
|
||||||
- Our forum serves as a primary communication hub for the staff team
|
- Our Discord community serves as a primary communication hub for the staff team
|
||||||
- A private `staff` category is available for internal discussions
|
- A private `staff` category is available for internal discussions
|
||||||
- Discord `#staff-chat` channel for real-time communication and coordination
|
- Discord `#staff-chat` channel for real-time communication and coordination
|
||||||
|
|
||||||
#### 3.1.2 Use of Staff Communication Channels
|
#### 3.1.2. Use of Staff Communication Channels
|
||||||
- Utilize staff channels for:
|
- Utilize staff channels for:
|
||||||
- Discussing concerns and seeking guidance on community issues
|
- Discussing concerns and seeking guidance on community issues
|
||||||
- Seeking advice on handling situations within your role
|
- Seeking advice on handling situations within your role
|
||||||
@@ -208,14 +208,14 @@ Know when and how to escalate issues:
|
|||||||
- Sharing relevant information and updates with the team
|
- Sharing relevant information and updates with the team
|
||||||
- Coordinating activities and ensuring smooth operations
|
- Coordinating activities and ensuring smooth operations
|
||||||
|
|
||||||
### 3.2 Collaborative Problem-Solving
|
### 3.2. Collaborative Problem-Solving
|
||||||
|
|
||||||
- Approach fellow staff members for help and insights when needed
|
- Approach fellow staff members for help and insights when needed
|
||||||
- Be open to offering assistance when others request it within your expertise
|
- Be open to offering assistance when others request it within your expertise
|
||||||
- Engage in constructive discussions to find optimal solutions
|
- Engage in constructive discussions to find optimal solutions
|
||||||
- Collaborate effectively across different roles and specialties
|
- Collaborate effectively across different roles and specialties
|
||||||
|
|
||||||
### 3.3 Team Unity and Public Image
|
### 3.3. Team Unity and Public Image
|
||||||
|
|
||||||
- Maintain a united front in public spaces
|
- Maintain a united front in public spaces
|
||||||
- Avoid disagreeing with or criticizing fellow staff members in public forums
|
- Avoid disagreeing with or criticizing fellow staff members in public forums
|
||||||
@@ -224,54 +224,54 @@ Know when and how to escalate issues:
|
|||||||
- Seek resolution through open and respectful dialogue
|
- Seek resolution through open and respectful dialogue
|
||||||
- Follow established conflict resolution procedures when needed
|
- Follow established conflict resolution procedures when needed
|
||||||
|
|
||||||
### 3.4 Conflict Resolution and Appeals
|
### 3.4. Conflict Resolution and Appeals
|
||||||
|
|
||||||
**Reference to Comprehensive Resolution Framework**: Detailed conflict resolution procedures, mediation processes, and appeals mechanisms are set forth in our Community Code of Conduct and Appeals Policy, which are incorporated herein by reference.
|
**Reference to Comprehensive Resolution Framework**: Detailed conflict resolution procedures, mediation processes, and appeals mechanisms are set forth in our Community Code of Conduct and Appeals Policy, which are incorporated herein by reference.
|
||||||
|
|
||||||
#### 3.4.1 Internal Staff Conflict Resolution
|
#### 3.4.1. Internal Staff Conflict Resolution
|
||||||
- Follow established conflict resolution procedures emphasising collaborative problem-solving
|
- Follow established conflict resolution procedures emphasising collaborative problem-solving
|
||||||
- Utilise mediation and restorative justice approaches when appropriate
|
- Utilise mediation and restorative justice approaches when appropriate
|
||||||
- Escalate to leadership team through proper channels when peer resolution is unsuccessful
|
- Escalate to leadership team through proper channels when peer resolution is unsuccessful
|
||||||
- Present situations objectively with comprehensive context and evidence
|
- Present situations objectively with comprehensive context and evidence
|
||||||
|
|
||||||
#### 3.4.2 Community Member Concerns and Support
|
#### 3.4.2. Community Member Concerns and Support
|
||||||
- Direct community members to appropriate resources and processes based on their needs
|
- Direct community members to appropriate resources and processes based on their needs
|
||||||
- Support community members in understanding available options and procedures
|
- Support community members in understanding available options and procedures
|
||||||
- Maintain professional boundaries whilst providing appropriate information and assistance
|
- Maintain professional boundaries whilst providing appropriate information and assistance
|
||||||
- Follow established protocols for handling member concerns and feedback
|
- Follow established protocols for handling member concerns and feedback
|
||||||
|
|
||||||
### 3.5 Supporting Each Other
|
### 3.5. Supporting Each Other
|
||||||
|
|
||||||
- Recognise that staff work can be challenging and sometimes emotionally demanding
|
- Recognise that staff work can be challenging and sometimes emotionally demanding
|
||||||
- Offer emotional support and encouragement to fellow staff members
|
- Offer emotional support and encouragement to fellow staff members
|
||||||
- Share experiences and coping strategies for dealing with difficult situations
|
- Share experiences and coping strategies for dealing with difficult situations
|
||||||
- Promote a supportive team environment that prioritises member wellness
|
- Promote a supportive team environment that prioritises member wellness
|
||||||
|
|
||||||
### 3.6 Knowledge Sharing
|
### 3.6. Knowledge Sharing
|
||||||
|
|
||||||
- Use staff channels to share useful resources, tools, or techniques relevant to your roles
|
- Use staff channels to share useful resources, tools, or techniques relevant to your roles
|
||||||
- Discuss emerging trends or patterns in community behaviour that may require attention
|
- Discuss emerging trends or patterns in community behaviour that may require attention
|
||||||
- Share learning opportunities and professional development resources with the team
|
- Share learning opportunities and professional development resources with the team
|
||||||
|
|
||||||
### 3.7 Consistency in Operations
|
### 3.7. Consistency in Operations
|
||||||
|
|
||||||
- Regularly discuss and align on interpretation and implementation of community policies
|
- Regularly discuss and align on interpretation and implementation of community policies
|
||||||
- Share examples of how you've handled specific situations to ensure consistency across the team
|
- Share examples of how you've handled specific situations to ensure consistency across the team
|
||||||
- Collaborate on developing best practices and standard procedures for common situations
|
- Collaborate on developing best practices and standard procedures for common situations
|
||||||
|
|
||||||
### 3.8 Respecting Privacy
|
### 3.8. Respecting Privacy
|
||||||
|
|
||||||
- Keep all discussions in staff channels confidential
|
- Keep all discussions in staff channels confidential
|
||||||
- Do not share private staff conversations with community members
|
- Do not share private staff conversations with community members
|
||||||
- Maintain appropriate professional boundaries regarding internal team information
|
- Maintain appropriate professional boundaries regarding internal team information
|
||||||
|
|
||||||
### 3.9 Active Participation
|
### 3.9. Active Participation
|
||||||
|
|
||||||
- Regularly check and engage in staff communications
|
- Regularly check and engage in staff communications
|
||||||
- Contribute to team discussions and decision-making processes
|
- Contribute to team discussions and decision-making processes
|
||||||
- Participate actively in team meetings and collaborative planning sessions
|
- Participate actively in team meetings and collaborative planning sessions
|
||||||
|
|
||||||
### 3.10 Continuous Improvement
|
### 3.10. Continuous Improvement
|
||||||
|
|
||||||
- Be open to feedback from fellow staff members and leadership
|
- Be open to feedback from fellow staff members and leadership
|
||||||
- Suggest improvements to processes, procedures, or team communication
|
- Suggest improvements to processes, procedures, or team communication
|
||||||
@@ -279,113 +279,113 @@ Know when and how to escalate issues:
|
|||||||
|
|
||||||
## 4. User Support
|
## 4. User Support
|
||||||
|
|
||||||
### 4.1 Role in User Experience
|
### 4.1. Role in User Experience
|
||||||
|
|
||||||
As a member of our team, you play a crucial role in ensuring a positive and smooth user experience across all our platforms. Your ability to provide timely and accurate support is essential to our community's satisfaction and growth.
|
As a member of our team, you play a crucial role in ensuring a positive and smooth user experience across all our platforms. Your ability to provide timely and accurate support is essential to our community's satisfaction and growth.
|
||||||
|
|
||||||
### 4.2 Knowledge Base
|
### 4.2. Knowledge Base
|
||||||
|
|
||||||
- Familiarize yourself with most of our projects to answer a wide range of questions.
|
- Familiarize yourself with most of our projects to answer a wide range of questions.
|
||||||
- Stay updated on recent changes or updates to our projects.
|
- Stay updated on recent changes or updates to our projects.
|
||||||
- Utilize available resources (documentation, FAQs, wikis) to assist users effectively.
|
- Utilize available resources (documentation, FAQs, wikis) to assist users effectively.
|
||||||
|
|
||||||
### 4.3 Handling User Inquiries
|
### 4.3. Handling User Inquiries
|
||||||
|
|
||||||
#### 4.3.1 Immediate Assistance
|
#### 4.3.1. Immediate Assistance
|
||||||
- Respond promptly to users seeking help on any of our platforms.
|
- Respond promptly to users seeking help on any of our platforms.
|
||||||
- Provide clear, concise answers to questions you're confident about.
|
- Provide clear, concise answers to questions you're confident about.
|
||||||
|
|
||||||
#### 4.3.2 Complex Inquiries
|
#### 4.3.2. Complex Inquiries
|
||||||
- For questions you're unsure about, don't hesitate to seek help.
|
- For questions you're unsure about, don't hesitate to seek help.
|
||||||
- Inform the user that you're looking into their issue to manage expectations.
|
- Inform the user that you're looking into their issue to manage expectations.
|
||||||
|
|
||||||
### 4.4 Collaborative Problem-Solving
|
### 4.4. Collaborative Problem-Solving
|
||||||
|
|
||||||
- Utilize the staff chat in Discord for discussing complex user questions.
|
- Utilize the staff chat in Discord for discussing complex user questions.
|
||||||
- Engage with fellow staff members to collaboratively find solutions.
|
- Engage with fellow staff members to collaboratively find solutions.
|
||||||
- Share knowledge and insights to improve the team's overall support capabilities.
|
- Share knowledge and insights to improve the team's overall support capabilities.
|
||||||
|
|
||||||
### 4.5 Follow-up
|
### 4.5. Follow-up
|
||||||
|
|
||||||
- After providing a solution, check if the user's issue has been fully resolved.
|
- After providing a solution, check if the user's issue has been fully resolved.
|
||||||
- Encourage users to reach out again if they need further assistance.
|
- Encourage users to reach out again if they need further assistance.
|
||||||
|
|
||||||
### 4.6 Continuous Improvement
|
### 4.6. Continuous Improvement
|
||||||
|
|
||||||
- Keep track of common user issues and suggest improvements to our documentation or user interfaces.
|
- Keep track of common user issues and suggest improvements to our documentation or user interfaces.
|
||||||
- Share insights gained from user interactions with the rest of the team to enhance our overall support quality.
|
- Share insights gained from user interactions with the rest of the team to enhance our overall support quality.
|
||||||
|
|
||||||
## 5. Contributor Support
|
## 5. Contributor Support
|
||||||
|
|
||||||
### 5.1 Welcoming New Contributors
|
### 5.1. Welcoming New Contributors
|
||||||
|
|
||||||
- Greet new contributors warmly when they show interest in our projects.
|
- Greet new contributors warmly when they show interest in our projects.
|
||||||
- Provide guidance on where to find our contribution guidelines and code of conduct.
|
- Provide guidance on where to find our contribution guidelines and code of conduct.
|
||||||
- Offer assistance in identifying suitable first issues or tasks for newcomers.
|
- Offer assistance in identifying suitable first issues or tasks for newcomers.
|
||||||
|
|
||||||
### 5.2 Technical Assistance
|
### 5.2. Technical Assistance
|
||||||
|
|
||||||
- Help contributors set up their development environments.
|
- Help contributors set up their development environments.
|
||||||
- Provide explanations or resources for understanding our project structure and coding standards.
|
- Provide explanations or resources for understanding our project structure and coding standards.
|
||||||
- Assist with version control (e.g. git) usage if needed.
|
- Assist with version control (e.g. git) usage if needed.
|
||||||
|
|
||||||
### 5.3 Code Review Support
|
### 5.3. Code Review Support
|
||||||
|
|
||||||
- Offer constructive feedback on pull requests or proposed changes.
|
- Offer constructive feedback on pull requests or proposed changes.
|
||||||
- Explain the reasoning behind any requested modifications.
|
- Explain the reasoning behind any requested modifications.
|
||||||
- Guide contributors through the process of updating their submissions.
|
- Guide contributors through the process of updating their submissions.
|
||||||
|
|
||||||
### 5.4 Documentation Support
|
### 5.4. Documentation Support
|
||||||
|
|
||||||
- Assist contributors in locating or updating project documentation.
|
- Assist contributors in locating or updating project documentation.
|
||||||
- Encourage and guide contributors who wish to improve our documentation.
|
- Encourage and guide contributors who wish to improve our documentation.
|
||||||
- Provide feedback on proposed documentation changes.
|
- Provide feedback on proposed documentation changes.
|
||||||
|
|
||||||
### 5.5 Issue Clarification
|
### 5.5. Issue Clarification
|
||||||
|
|
||||||
- Help contributors understand the scope and requirements of open issues.
|
- Help contributors understand the scope and requirements of open issues.
|
||||||
- Provide additional context or clarification on feature requests or bug reports.
|
- Provide additional context or clarification on feature requests or bug reports.
|
||||||
|
|
||||||
### 5.6 Communication Channels
|
### 5.6. Communication Channels
|
||||||
|
|
||||||
- Direct contributors to appropriate communication channels (e.g., mailing lists, chat rooms, forums) for project-specific discussions.
|
- Direct contributors to appropriate communication channels (e.g., mailing lists, chat rooms, forums) for project-specific discussions.
|
||||||
- Monitor these channels to provide timely responses to contributor queries.
|
- Monitor these channels to provide timely responses to contributor queries.
|
||||||
|
|
||||||
### 5.7 Mentoring
|
### 5.7. Mentoring
|
||||||
|
|
||||||
- Offer mentorship to promising contributors who show consistent interest.
|
- Offer mentorship to promising contributors who show consistent interest.
|
||||||
- Provide guidance on best practices, advanced topics, and project goals.
|
- Provide guidance on best practices, advanced topics, and project goals.
|
||||||
|
|
||||||
### 5.8 Recognition and Encouragement
|
### 5.8. Recognition and Encouragement
|
||||||
|
|
||||||
- Acknowledge and thank contributors for their efforts, regardless of the outcome.
|
- Acknowledge and thank contributors for their efforts, regardless of the outcome.
|
||||||
- Highlight significant contributions in project updates or community announcements.
|
- Highlight significant contributions in project updates or community announcements.
|
||||||
|
|
||||||
### 5.9 Conflict Resolution
|
### 5.9. Conflict Resolution
|
||||||
|
|
||||||
- Mediate any disagreements between contributors professionally and impartially.
|
- Mediate any disagreements between contributors professionally and impartially.
|
||||||
- Ensure discussions remain constructive and aligned with our code of conduct.
|
- Ensure discussions remain constructive and aligned with our code of conduct.
|
||||||
|
|
||||||
### 5.10 Continuous Improvement
|
### 5.10. Continuous Improvement
|
||||||
|
|
||||||
- Regularly review and update our contribution processes based on feedback.
|
- Regularly review and update our contribution processes based on feedback.
|
||||||
- Seek input from contributors on how to improve their experience.
|
- Seek input from contributors on how to improve their experience.
|
||||||
|
|
||||||
## 6. Cross-Platform Access
|
## 6. Cross-Platform Access
|
||||||
|
|
||||||
### 6.1 Eligibility for Cross-Platform Roles
|
### 6.1. Eligibility for Cross-Platform Roles
|
||||||
|
|
||||||
- Once you have been selected for a staff position on any of our platforms, you become eligible to request staff access on additional platforms.
|
- Once you have been selected for a staff position on any of our platforms, you become eligible to request staff access on additional platforms.
|
||||||
- This opportunity is open to all current staff members in good standing.
|
- This opportunity is open to all current staff members in good standing.
|
||||||
|
|
||||||
### 6.2 Requesting Additional Platform Access
|
### 6.2. Requesting Additional Platform Access
|
||||||
|
|
||||||
- If you wish to expand your staff role to other platforms:
|
- If you wish to expand your staff role to other platforms:
|
||||||
- Express your interest to an admin or through the designated channel for such requests.
|
- Express your interest to an admin or through the designated channel for such requests.
|
||||||
- Specify which additional platform(s) you'd like to moderate.
|
- Specify which additional platform(s) you'd like to moderate.
|
||||||
- Briefly explain why you're interested in moderating these additional platforms.
|
- Briefly explain why you're interested in moderating these additional platforms.
|
||||||
|
|
||||||
### 6.3 Approval Process
|
### 6.3. Approval Process
|
||||||
|
|
||||||
- Requests for additional platform access will be reviewed by the admin team.
|
- Requests for additional platform access will be reviewed by the admin team.
|
||||||
- Factors considered in the approval process may include:
|
- Factors considered in the approval process may include:
|
||||||
@@ -393,39 +393,39 @@ As a member of our team, you play a crucial role in ensuring a positive and smoo
|
|||||||
- Your familiarity with the requested platform
|
- Your familiarity with the requested platform
|
||||||
- The current staffing needs on that platform
|
- The current staffing needs on that platform
|
||||||
|
|
||||||
### 6.4 Training and Onboarding
|
### 6.4. Training and Onboarding
|
||||||
|
|
||||||
- If approved for a cross-platform role, you may be required to undergo platform-specific training.
|
- If approved for a cross-platform role, you may be required to undergo platform-specific training.
|
||||||
- Familiarize yourself with any unique rules or moderation tools for the new platform.
|
- Familiarize yourself with any unique rules or moderation tools for the new platform.
|
||||||
|
|
||||||
### 6.5 Responsibilities of Cross-Platform Staff
|
### 6.5. Responsibilities of Cross-Platform Staff
|
||||||
|
|
||||||
- Maintain consistency in rule enforcement across all platforms you moderate.
|
- Maintain consistency in rule enforcement across all platforms you moderate.
|
||||||
- Be aware of platform-specific nuances and adjust your approach accordingly.
|
- Be aware of platform-specific nuances and adjust your approach accordingly.
|
||||||
- Help bridge communication between different platform teams.
|
- Help bridge communication between different platform teams.
|
||||||
|
|
||||||
### 6.6 Benefits of Cross-Platform Moderation
|
### 6.6. Benefits of Cross-Platform Moderation
|
||||||
|
|
||||||
- Provides a more cohesive user experience across our community's various platforms.
|
- Provides a more cohesive user experience across our community's various platforms.
|
||||||
- Allows for more efficient sharing of information and moderation strategies.
|
- Allows for more efficient sharing of information and moderation strategies.
|
||||||
- Enhances your skills and versatility as a moderator.
|
- Enhances your skills and versatility as a moderator.
|
||||||
|
|
||||||
### 6.7 Balancing Responsibilities
|
### 6.7. Balancing Responsibilities
|
||||||
|
|
||||||
- Ensure that taking on additional platforms does not negatively impact your performance on your original platform.
|
- Ensure that taking on additional platforms does not negatively impact your performance on your original platform.
|
||||||
- Communicate with the moderation team if you feel overwhelmed or need to scale back your responsibilities.
|
- Communicate with the moderation team if you feel overwhelmed or need to scale back your responsibilities.
|
||||||
|
|
||||||
### 6.8 Performance Review and Continuous Improvement
|
### 6.8. Performance Review and Continuous Improvement
|
||||||
|
|
||||||
**Reference to Comprehensive Review Framework**: Detailed performance review processes, community feedback integration, and continuous improvement systems are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Review Framework**: Detailed performance review processes, community feedback integration, and continuous improvement systems are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
#### 6.8.1 Regular Performance Assessment
|
#### 6.8.1. Regular Performance Assessment
|
||||||
- Quarterly performance reviews incorporating community feedback and peer evaluation
|
- Quarterly performance reviews incorporating community feedback and peer evaluation
|
||||||
- Annual comprehensive assessments with goal-setting and development planning
|
- Annual comprehensive assessments with goal-setting and development planning
|
||||||
- 360-degree feedback including community members, peers, and leadership input
|
- 360-degree feedback including community members, peers, and leadership input
|
||||||
- Professional development opportunities and skill enhancement support
|
- Professional development opportunities and skill enhancement support
|
||||||
|
|
||||||
#### 6.8.2 Community Accountability
|
#### 6.8.2. Community Accountability
|
||||||
- Community feedback integration through surveys and input mechanisms
|
- Community feedback integration through surveys and input mechanisms
|
||||||
- Transparent performance reporting while respecting individual privacy
|
- Transparent performance reporting while respecting individual privacy
|
||||||
- Responsive improvement planning based on community needs and feedback
|
- Responsive improvement planning based on community needs and feedback
|
||||||
@@ -433,7 +433,7 @@ As a member of our team, you play a crucial role in ensuring a positive and smoo
|
|||||||
|
|
||||||
## 7. Legal Framework and Policy Compliance
|
## 7. Legal Framework and Policy Compliance
|
||||||
|
|
||||||
### 7.1 Comprehensive Policy Integration
|
### 7.1. Comprehensive Policy Integration
|
||||||
|
|
||||||
All staff members must comply with our complete legal and policy framework:
|
All staff members must comply with our complete legal and policy framework:
|
||||||
|
|
||||||
@@ -449,15 +449,15 @@ All staff members must comply with our complete legal and policy framework:
|
|||||||
|
|
||||||
**(f)** **All Community Policies**: Code of conduct, leadership governance, recognition systems, and participation frameworks.
|
**(f)** **All Community Policies**: Code of conduct, leadership governance, recognition systems, and participation frameworks.
|
||||||
|
|
||||||
### 7.2 Staff Legal Obligations
|
### 7.2. Staff Legal Obligations
|
||||||
|
|
||||||
#### 7.2.1 Policy Adherence Requirements
|
#### 7.2.1. Policy Adherence Requirements
|
||||||
- Comprehensive understanding of all applicable policies and their practical implementation
|
- Comprehensive understanding of all applicable policies and their practical implementation
|
||||||
- Regular policy review and update acknowledgement as frameworks evolve
|
- Regular policy review and update acknowledgement as frameworks evolve
|
||||||
- Professional application of policies with consistency and cultural sensitivity
|
- Professional application of policies with consistency and cultural sensitivity
|
||||||
- Escalation of complex legal or policy questions through proper channels
|
- Escalation of complex legal or policy questions through proper channels
|
||||||
|
|
||||||
#### 7.2.2 Community Protection and Safety
|
#### 7.2.2. Community Protection and Safety
|
||||||
- Prioritisation of community member safety and well-being in all decisions
|
- Prioritisation of community member safety and well-being in all decisions
|
||||||
- Appropriate handling of sensitive information with privacy protection
|
- Appropriate handling of sensitive information with privacy protection
|
||||||
- Recognition of mandatory reporting obligations where legally required
|
- Recognition of mandatory reporting obligations where legally required
|
||||||
@@ -465,31 +465,31 @@ All staff members must comply with our complete legal and policy framework:
|
|||||||
|
|
||||||
## 8. Professional Development and Support
|
## 8. Professional Development and Support
|
||||||
|
|
||||||
### 8.1 Training and Education Programs
|
### 8.1. Training and Education Programs
|
||||||
|
|
||||||
**Reference to Comprehensive Development Framework**: Detailed training programs, professional development opportunities, and leadership skill enhancement are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
**Reference to Comprehensive Development Framework**: Detailed training programmes, professional development opportunities, and leadership skill enhancement are set forth in our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
#### 8.1.1 Mandatory Training Components
|
#### 8.1.1. Mandatory Training Components
|
||||||
- Foundation training in community values, mission, and policy frameworks
|
- Foundation training in community values, mission, and policy frameworks
|
||||||
- Conflict resolution and mediation skills development
|
- Conflict resolution and mediation skills development
|
||||||
- Accessibility and inclusive practices certification
|
- Accessibility and inclusive practices certification
|
||||||
- Cultural competency and trauma-informed practices education
|
- Cultural competency and trauma-informed practices education
|
||||||
|
|
||||||
#### 8.1.2 Ongoing Development Opportunities
|
#### 8.1.2. Ongoing Development Opportunities
|
||||||
- Leadership coaching and mentorship programs
|
- Leadership coaching and mentorship programmes
|
||||||
- External training and conference attendance support
|
- External training and conference attendance support
|
||||||
- Cross-functional experience and role advancement opportunities
|
- Cross-functional experience and role advancement opportunities
|
||||||
- Professional networking and community management best practices
|
- Professional networking and community management best practices
|
||||||
|
|
||||||
### 8.2 Wellness and Support Systems
|
### 8.2. Wellness and Support Systems
|
||||||
|
|
||||||
#### 8.2.1 Volunteer Wellness Priority
|
#### 8.2.1. Volunteer Wellness Priority
|
||||||
- Recognition that volunteer well-being is essential for sustainable community service
|
- Recognition that volunteer well-being is essential for sustainable community service
|
||||||
- Regular wellness check-ins and proactive intervention when support is needed
|
- Regular wellness check-ins and proactive intervention when support is needed
|
||||||
- Flexible arrangements accommodating personal circumstances and life changes
|
- Flexible arrangements accommodating personal circumstances and life changes
|
||||||
- Access to mental health resources and peer support networks
|
- Access to mental health resources and peer support networks
|
||||||
|
|
||||||
#### 8.2.2 Burnout Prevention and Management
|
#### 8.2.2. Burnout Prevention and Management
|
||||||
- Clear role boundaries and expectation setting to prevent volunteer overextension
|
- Clear role boundaries and expectation setting to prevent volunteer overextension
|
||||||
- Mandatory rest periods and vacation time for sustainable volunteer engagement
|
- Mandatory rest periods and vacation time for sustainable volunteer engagement
|
||||||
- Workload assessment and redistribution systems to maintain healthy participation levels
|
- Workload assessment and redistribution systems to maintain healthy participation levels
|
||||||
@@ -505,4 +505,4 @@ Your service as a volunteer staff member contributes to creating spaces where al
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Staff Handbook was last updated on 15 September 2025 and operates within our comprehensive legal and policy framework. For questions about staff responsibilities or policy interpretation, please contact leadership through designated staff channels.*
|
*This Staff Handbook. For questions about staff responsibilities or policy interpretation, please contact leadership through designated staff channels.*
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ title: Staff Policy Self-Assessment
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This self-assessment tool is designed to help you evaluate your understanding and comprehension of our organization's policies, procedures, and community standards. It covers all major policy areas that staff members are expected to know and apply in their roles.
|
This self-assessment tool is designed to help you evaluate your understanding and comprehension of our organisation's policies, procedures, and community standards. It covers all major policy areas that staff members are expected to know and apply in their roles.
|
||||||
|
|
||||||
**How to Use This Assessment:**
|
**How to Use This Assessment:**
|
||||||
- Answer each question honestly and thoroughly
|
- Answer each question honestly and thoroughly
|
||||||
@@ -32,7 +32,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 1: Community Values and Code of Conduct
|
## Section 1: Community Values and Code of Conduct
|
||||||
|
|
||||||
### 1.1 Foundational Principles
|
### 1.1. Foundational Principles
|
||||||
|
|
||||||
**Question 1:** Our community explicitly rejects neutrality in the face of oppression. Explain what this means and how it should guide your actions as a staff member.
|
**Question 1:** Our community explicitly rejects neutrality in the face of oppression. Explain what this means and how it should guide your actions as a staff member.
|
||||||
|
|
||||||
@@ -52,15 +52,15 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 1.2 Prohibited Conduct
|
### 1.2. Prohibited Conduct
|
||||||
|
|
||||||
**Question 4:** What is the difference between impact and intent when assessing harmful behavior? Provide an example.
|
**Question 4:** What is the difference between impact and intent when assessing harmful behaviour? Provide an example.
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 5:** A user claims they're just "playing devil's advocate" when making arguments that harm marginalized community members. How do you respond?
|
**Question 5:** A user claims they're just "playing devil's advocate" when making arguments that harm marginalised community members. How do you respond?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 1.3 Reporting and Enforcement
|
### 1.3. Reporting and Enforcement
|
||||||
|
|
||||||
**Question 7:** List the different ways community members can report Code of Conduct violations:
|
**Question 7:** List the different ways community members can report Code of Conduct violations:
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 2: Staff Handbook and Professional Conduct
|
## Section 2: Staff Handbook and Professional Conduct
|
||||||
|
|
||||||
### 2.1 Role Definition and Expectations
|
### 2.1. Role Definition and Expectations
|
||||||
|
|
||||||
**Question 10:** Explain the "servant leadership" principle and how it applies to all staff roles:
|
**Question 10:** Explain the "servant leadership" principle and how it applies to all staff roles:
|
||||||
|
|
||||||
@@ -114,9 +114,9 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 2.2 Professional Standards
|
### 2.2. Professional Standards
|
||||||
|
|
||||||
**Question 13:** List five mandatory behaviors expected of all staff members:
|
**Question 13:** List five mandatory behaviours expected of all staff members:
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 2.3 Documentation and Accountability
|
### 2.3. Documentation and Accountability
|
||||||
|
|
||||||
**Question 16:** What types of actions must be documented, and why is this important?
|
**Question 16:** What types of actions must be documented, and why is this important?
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 3: Crisis and Mental Health Management
|
## Section 3: Crisis and Mental Health Management
|
||||||
|
|
||||||
### 3.1 Crisis Recognition
|
### 3.1. Crisis Recognition
|
||||||
|
|
||||||
**Question 18:** List at least 5 warning signs that might indicate someone is experiencing a mental health crisis:
|
**Question 18:** List at least 5 warning signs that might indicate someone is experiencing a mental health crisis:
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 3.2 Response Protocols
|
### 3.2. Response Protocols
|
||||||
|
|
||||||
**Question 21:** When are we legally obligated to report mental health concerns to authorities?
|
**Question 21:** When are we legally obligated to report mental health concerns to authorities?
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 3.3 Professional Boundaries
|
### 3.3. Professional Boundaries
|
||||||
|
|
||||||
**Question 24:** What are the limitations of peer support vs. professional mental health services?
|
**Question 24:** What are the limitations of peer support vs. professional mental health services?
|
||||||
|
|
||||||
@@ -206,7 +206,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 4: Community Support and Growth
|
## Section 4: Community Support and Growth
|
||||||
|
|
||||||
### 4.1 Community Support Framework
|
### 4.1. Community Support Framework
|
||||||
|
|
||||||
**Question 26:** What are the four main categories of support available in our community?
|
**Question 26:** What are the four main categories of support available in our community?
|
||||||
|
|
||||||
@@ -226,7 +226,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 4.2 Community Growth Principles
|
### 4.2. Community Growth Principles
|
||||||
|
|
||||||
**Question 29:** Explain our "quality over quantity" approach to community growth:
|
**Question 29:** Explain our "quality over quantity" approach to community growth:
|
||||||
|
|
||||||
@@ -246,7 +246,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 4.3 New Member Integration
|
### 4.3. New Member Integration
|
||||||
|
|
||||||
**Question 32:** Describe the key elements of effective new member onboarding:
|
**Question 32:** Describe the key elements of effective new member onboarding:
|
||||||
|
|
||||||
@@ -262,7 +262,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 5: Moderation and Enforcement
|
## Section 5: Moderation and Enforcement
|
||||||
|
|
||||||
### 5.1 Inclusive Moderation Principles
|
### 5.1. Inclusive Moderation Principles
|
||||||
|
|
||||||
**Question 34:** What does "inclusive moderation" mean beyond just enforcing written rules?
|
**Question 34:** What does "inclusive moderation" mean beyond just enforcing written rules?
|
||||||
|
|
||||||
@@ -270,7 +270,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 35:** How should you prioritize safety for marginalized community members in your moderation decisions?
|
**Question 35:** How should you prioritise safety for marginalised community members in your moderation decisions?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -282,7 +282,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 5.2 Conflict Resolution
|
### 5.2. Conflict Resolution
|
||||||
|
|
||||||
**Question 37:** List the four stages of conflict escalation and appropriate interventions for each:
|
**Question 37:** List the four stages of conflict escalation and appropriate interventions for each:
|
||||||
|
|
||||||
@@ -302,7 +302,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 5.3 Cultural Competency
|
### 5.3. Cultural Competency
|
||||||
|
|
||||||
**Question 40:** How do cultural differences in communication styles affect moderation decisions?
|
**Question 40:** How do cultural differences in communication styles affect moderation decisions?
|
||||||
|
|
||||||
@@ -324,7 +324,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 6: Appeals and Review Processes
|
## Section 6: Appeals and Review Processes
|
||||||
|
|
||||||
### 6.1 Appeals Framework
|
### 6.1. Appeals Framework
|
||||||
|
|
||||||
**Question 43:** What are the acceptable grounds for appealing a disciplinary decision?
|
**Question 43:** What are the acceptable grounds for appealing a disciplinary decision?
|
||||||
|
|
||||||
@@ -344,7 +344,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 6.2 Appeals Process
|
### 6.2. Appeals Process
|
||||||
|
|
||||||
**Question 46:** Describe the review process and typical timeline for appeals:
|
**Question 46:** Describe the review process and typical timeline for appeals:
|
||||||
|
|
||||||
@@ -364,7 +364,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 6.3 Review and Accountability
|
### 6.3. Review and Accountability
|
||||||
|
|
||||||
**Question 49:** How do you handle a situation where a community member wants to appeal a decision you made?
|
**Question 49:** How do you handle a situation where a community member wants to appeal a decision you made?
|
||||||
|
|
||||||
@@ -380,7 +380,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 7: Privacy and Data Protection
|
## Section 7: Privacy and Data Protection
|
||||||
|
|
||||||
### 7.1 Data Collection and Use
|
### 7.1. Data Collection and Use
|
||||||
|
|
||||||
**Question 51:** What types of personal information do we collect from community members?
|
**Question 51:** What types of personal information do we collect from community members?
|
||||||
|
|
||||||
@@ -400,7 +400,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 7.2 Data Protection Principles
|
### 7.2. Data Protection Principles
|
||||||
|
|
||||||
**Question 54:** If a community member requests their personal data be deleted, what should you do?
|
**Question 54:** If a community member requests their personal data be deleted, what should you do?
|
||||||
|
|
||||||
@@ -422,7 +422,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 8: Content Moderation and Safety
|
## Section 8: Content Moderation and Safety
|
||||||
|
|
||||||
### 8.1 Content Standards
|
### 8.1. Content Standards
|
||||||
|
|
||||||
**Question 57:** Beyond explicit rule violations, what other factors should guide content moderation decisions?
|
**Question 57:** Beyond explicit rule violations, what other factors should guide content moderation decisions?
|
||||||
|
|
||||||
@@ -430,7 +430,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 58:** How do you handle content that might be harmful to marginalized community members but doesn't explicitly violate written rules?
|
**Question 58:** How do you handle content that might be harmful to marginalised community members but doesn't explicitly violate written rules?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -442,7 +442,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 8.2 Safety and Protection
|
### 8.2. Safety and Protection
|
||||||
|
|
||||||
**Question 60:** Describe the process for handling reports of harassment that span multiple platforms:
|
**Question 60:** Describe the process for handling reports of harassment that span multiple platforms:
|
||||||
|
|
||||||
@@ -464,7 +464,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 9: Accessibility and Inclusion
|
## Section 9: Accessibility and Inclusion
|
||||||
|
|
||||||
### 9.1 Accessibility Principles
|
### 9.1. Accessibility Principles
|
||||||
|
|
||||||
**Question 63:** What are the key accessibility considerations for community platforms and activities?
|
**Question 63:** What are the key accessibility considerations for community platforms and activities?
|
||||||
|
|
||||||
@@ -484,7 +484,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 9.2 Inclusive Practices
|
### 9.2. Inclusive Practices
|
||||||
|
|
||||||
**Question 66:** Describe how you ensure that community events and discussions are inclusive of different time zones, languages, and cultural backgrounds:
|
**Question 66:** Describe how you ensure that community events and discussions are inclusive of different time zones, languages, and cultural backgrounds:
|
||||||
|
|
||||||
@@ -498,7 +498,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 68:** How do you address barriers that might prevent marginalized community members from fully participating?
|
**Question 68:** How do you address barriers that might prevent marginalised community members from fully participating?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -506,7 +506,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 10: Training-Specific Knowledge
|
## Section 10: Training-Specific Knowledge
|
||||||
|
|
||||||
### 10.1 Role-Specific Competencies
|
### 10.1. Role-Specific Competencies
|
||||||
|
|
||||||
**Question 69:** If you're in a moderation role, list the core competencies required for effective conflict resolution:
|
**Question 69:** If you're in a moderation role, list the core competencies required for effective conflict resolution:
|
||||||
|
|
||||||
@@ -526,7 +526,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 10.2 Specialized Knowledge Areas
|
### 10.2. Specialized Knowledge Areas
|
||||||
|
|
||||||
**Question 72:** If working with accessibility coordination, what are the key principles you need to understand?
|
**Question 72:** If working with accessibility coordination, what are the key principles you need to understand?
|
||||||
|
|
||||||
@@ -540,7 +540,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 74:** In crisis response situations, what specialized training is required?
|
**Question 74:** In crisis response situations, what specialised training is required?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -548,7 +548,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 11: Legal and Policy Framework
|
## Section 11: Legal and Policy Framework
|
||||||
|
|
||||||
### 11.1 Policy Integration
|
### 11.1. Policy Integration
|
||||||
|
|
||||||
**Question 75:** List the major policy documents that all staff members must understand and comply with:
|
**Question 75:** List the major policy documents that all staff members must understand and comply with:
|
||||||
|
|
||||||
@@ -568,7 +568,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 11.2 Legal Obligations
|
### 11.2. Legal Obligations
|
||||||
|
|
||||||
**Question 78:** What are our mandatory reporting obligations, and when do they apply?
|
**Question 78:** What are our mandatory reporting obligations, and when do they apply?
|
||||||
|
|
||||||
@@ -590,7 +590,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 12: Practical Application Scenarios
|
## Section 12: Practical Application Scenarios
|
||||||
|
|
||||||
### 12.1 Complex Situations
|
### 12.1. Complex Situations
|
||||||
|
|
||||||
**Question 81:** A long-time community member makes transphobic comments. They claim they're "just asking questions" and "trying to understand." How do you handle this situation from first contact through resolution?
|
**Question 81:** A long-time community member makes transphobic comments. They claim they're "just asking questions" and "trying to understand." How do you handle this situation from first contact through resolution?
|
||||||
|
|
||||||
@@ -610,7 +610,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 12.2 Edge Cases
|
### 12.2. Edge Cases
|
||||||
|
|
||||||
**Question 84:** A staff member is involved in a conflict with a community member. You need to address the situation but the usual procedures involve that staff member. What do you do?
|
**Question 84:** A staff member is involved in a conflict with a community member. You need to address the situation but the usual procedures involve that staff member. What do you do?
|
||||||
|
|
||||||
@@ -644,7 +644,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 13: Self-Reflection and Continuous Improvement
|
## Section 13: Self-Reflection and Continuous Improvement
|
||||||
|
|
||||||
### 13.1 Personal Assessment
|
### 13.1. Personal Assessment
|
||||||
|
|
||||||
**Question 89:** Reflect on your own potential biases. What areas do you need to be most mindful about in your staff role?
|
**Question 89:** Reflect on your own potential biases. What areas do you need to be most mindful about in your staff role?
|
||||||
|
|
||||||
@@ -664,7 +664,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 13.2 Community Impact
|
### 13.2. Community Impact
|
||||||
|
|
||||||
**Question 92:** How would you evaluate whether your actions as a staff member are effectively supporting our community values?
|
**Question 92:** How would you evaluate whether your actions as a staff member are effectively supporting our community values?
|
||||||
|
|
||||||
@@ -686,7 +686,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 14: Resource Knowledge
|
## Section 14: Resource Knowledge
|
||||||
|
|
||||||
### 14.1 Support Resources
|
### 14.1. Support Resources
|
||||||
|
|
||||||
**Question 95:** List key mental health crisis resources for different regions:
|
**Question 95:** List key mental health crisis resources for different regions:
|
||||||
|
|
||||||
@@ -706,7 +706,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 14.2 External Resources
|
### 14.2. External Resources
|
||||||
|
|
||||||
**Question 98:** If someone needs legal advice, professional counselling, or other services outside our scope, how do you connect them with appropriate resources?
|
**Question 98:** If someone needs legal advice, professional counselling, or other services outside our scope, how do you connect them with appropriate resources?
|
||||||
|
|
||||||
@@ -716,7 +716,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
## Section 15: Advanced Integration and Leadership
|
## Section 15: Advanced Integration and Leadership
|
||||||
|
|
||||||
### 15.1 Cross-Platform Coordination
|
### 15.1. Cross-Platform Coordination
|
||||||
|
|
||||||
**Question 99:** How do you ensure consistent policy application across Discord, forums, Reddit, GitHub, and other community platforms?
|
**Question 99:** How do you ensure consistent policy application across Discord, forums, Reddit, GitHub, and other community platforms?
|
||||||
|
|
||||||
@@ -730,7 +730,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 15.2 Community Leadership and Governance
|
### 15.2. Community Leadership and Governance
|
||||||
|
|
||||||
**Question 101:** Describe how community feedback is integrated into policy development and modification:
|
**Question 101:** Describe how community feedback is integrated into policy development and modification:
|
||||||
|
|
||||||
@@ -750,7 +750,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 15.3 Training and Development
|
### 15.3. Training and Development
|
||||||
|
|
||||||
**Question 104:** If you were to mentor a new staff member, what would be your approach to helping them understand our policies?
|
**Question 104:** If you were to mentor a new staff member, what would be your approach to helping them understand our policies?
|
||||||
|
|
||||||
@@ -770,7 +770,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 15.4 Crisis and Emergency Situations
|
### 15.4. Crisis and Emergency Situations
|
||||||
|
|
||||||
**Question 107:** Describe your approach to handling a community-wide crisis that requires immediate response across multiple platforms:
|
**Question 107:** Describe your approach to handling a community-wide crisis that requires immediate response across multiple platforms:
|
||||||
|
|
||||||
@@ -778,7 +778,7 @@ This self-assessment tool is designed to help you evaluate your understanding an
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Question 108:** How do you prioritize competing demands during high-stress situations while maintaining policy compliance?
|
**Question 108:** How do you prioritise competing demands during high-stress situations while maintaining policy compliance?
|
||||||
|
|
||||||
*Your Answer:*
|
*Your Answer:*
|
||||||
|
|
||||||
@@ -844,8 +844,6 @@ Based on your assessment results:
|
|||||||
|
|
||||||
**Learning Plan:**
|
**Learning Plan:**
|
||||||
|
|
||||||
**Next Review Date:** _______________
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Supervisor Review**
|
**Supervisor Review**
|
||||||
@@ -861,7 +859,3 @@ Based on your assessment results:
|
|||||||
---
|
---
|
||||||
|
|
||||||
*This Policy Self-Assessment is designed to support continuous learning and professional development. It should be completed regularly and used as part of ongoing training and performance development discussions. For questions about specific policy areas or assessment results, contact leadership through designated staff channels.*
|
*This Policy Self-Assessment is designed to support continuous learning and professional development. It should be completed regularly and used as part of ongoing training and performance development discussions. For questions about specific policy areas or assessment results, contact leadership through designated staff channels.*
|
||||||
|
|
||||||
**Document Version:** 1.0
|
|
||||||
**Last Updated:** 25 September 2025
|
|
||||||
**Next Review Date:** 25 March 2026
|
|
||||||
@@ -6,21 +6,21 @@ title: Professional Conduct Standards for Volunteers
|
|||||||
|
|
||||||
## 1. POLICY STATEMENT AND SCOPE
|
## 1. POLICY STATEMENT AND SCOPE
|
||||||
|
|
||||||
### 1.1 Professional Conduct Commitment
|
### 1.1. Professional Conduct Commitment
|
||||||
|
|
||||||
All volunteers representing our organization are required to maintain the highest standards of professional conduct in all activities, interactions, and representations of the organization. This policy establishes mandatory expectations, requirements, and accountability measures for professional behavior.
|
All volunteers representing our organisation are required to maintain the highest standards of professional conduct in all activities, interactions, and representations of the organisation. This policy establishes mandatory expectations, requirements, and accountability measures for professional behaviour.
|
||||||
|
|
||||||
### 1.2 Policy Scope and Application
|
### 1.2. Policy Scope and Application
|
||||||
|
|
||||||
**(a)** This policy applies to all volunteer positions and roles within the organization;
|
**(a)** This policy applies to all volunteer positions and roles within the organisation;
|
||||||
|
|
||||||
**(b)** Standards apply during all volunteer activities, official communications, and public representations;
|
**(b)** Standards apply during all volunteer activities, official communications, and public representations;
|
||||||
|
|
||||||
**(c)** Requirements extend to all platforms, channels, and mediums of organizational participation;
|
**(c)** Requirements extend to all platforms, channels, and mediums of organisational participation;
|
||||||
|
|
||||||
**(d)** Policy covers interactions with community members, colleagues, stakeholders, and external parties.
|
**(d)** Policy covers interactions with community members, colleagues, stakeholders, and external parties.
|
||||||
|
|
||||||
### 1.3 Mandatory Compliance and Enforcement
|
### 1.3. Mandatory Compliance and Enforcement
|
||||||
|
|
||||||
**(a)** Compliance with these standards is mandatory and non-negotiable for all volunteers;
|
**(a)** Compliance with these standards is mandatory and non-negotiable for all volunteers;
|
||||||
|
|
||||||
@@ -32,29 +32,29 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
## 2. FOUNDATIONAL PRINCIPLES AND VALUES
|
## 2. FOUNDATIONAL PRINCIPLES AND VALUES
|
||||||
|
|
||||||
### 2.1 Respect and Human Dignity
|
### 2.1. Respect and Human Dignity
|
||||||
|
|
||||||
**(a)** **Universal Respect**: Treat all community members, colleagues, and stakeholders with respect and dignity without exception;
|
**(a)** **Universal Respect**: Treat all community members, colleagues, and stakeholders with respect and dignity without exception;
|
||||||
|
|
||||||
**(b)** **Inclusive Communication**: Use inclusive language and avoid discriminatory comments, behavior, or microaggressions;
|
**(b)** **Inclusive Communication**: Use inclusive language and avoid discriminatory comments, behaviour, or microaggressions;
|
||||||
|
|
||||||
**(c)** **Diversity Appreciation**: Actively respect and value diverse perspectives, backgrounds, identities, and experiences;
|
**(c)** **Diversity Appreciation**: Actively respect and value diverse perspectives, backgrounds, identities, and experiences;
|
||||||
|
|
||||||
**(d)** **Confidentiality Protection**: Maintain strict confidentiality when handling sensitive information and personal data.
|
**(d)** **Confidentiality Protection**: Maintain strict confidentiality when handling sensitive information and personal data.
|
||||||
|
|
||||||
### 2.2 Professional Communication Standards
|
### 2.2. Professional Communication Standards
|
||||||
|
|
||||||
**(a)** **Communication Excellence**: Communicate clearly, constructively, and professionally in all interactions across all platforms;
|
**(a)** **Communication Excellence**: Communicate clearly, constructively, and professionally in all interactions across all platforms;
|
||||||
|
|
||||||
**(b)** **Response Timeliness**: Respond to inquiries and messages within established timeframes appropriate to the communication channel;
|
**(b)** **Response Timeliness**: Respond to inquiries and messages within established timeframes appropriate to the communication channel;
|
||||||
|
|
||||||
**(c)** **Channel Appropriateness**: Use appropriate communication channels for different types of organizational business;
|
**(c)** **Channel Appropriateness**: Use appropriate communication channels for different types of organisational business;
|
||||||
|
|
||||||
**(d)** **Professional Tone**: Maintain professional tone and language in all written and verbal communications.
|
**(d)** **Professional Tone**: Maintain professional tone and language in all written and verbal communications.
|
||||||
|
|
||||||
### 2.3 Integrity and Accountability Framework
|
### 2.3. Integrity and Accountability Framework
|
||||||
|
|
||||||
**(a)** **Transparency Requirement**: Act honestly and transparently in all volunteer activities and organizational representations;
|
**(a)** **Transparency Requirement**: Act honestly and transparently in all volunteer activities and organisational representations;
|
||||||
|
|
||||||
**(b)** **Personal Responsibility**: Take full responsibility for your actions, decisions, and their consequences;
|
**(b)** **Personal Responsibility**: Take full responsibility for your actions, decisions, and their consequences;
|
||||||
|
|
||||||
@@ -64,9 +64,9 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
## 3. MANDATORY BEHAVIOR STANDARDS
|
## 3. MANDATORY BEHAVIOR STANDARDS
|
||||||
|
|
||||||
### 3.1 Community Interaction Requirements
|
### 3.1. Community Interaction Requirements
|
||||||
|
|
||||||
**(a)** **Positive Modeling**: Consistently model positive, professional behavior for community members in all interactions;
|
**(a)** **Positive Modeling**: Consistently model positive, professional behaviour for community members in all interactions;
|
||||||
|
|
||||||
**(b)** **Conflict Management**: Address conflicts calmly, professionally, and in accordance with established procedures;
|
**(b)** **Conflict Management**: Address conflicts calmly, professionally, and in accordance with established procedures;
|
||||||
|
|
||||||
@@ -74,29 +74,29 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(d)** **Impartiality Maintenance**: Maintain strict impartiality when mediating disputes or addressing community issues.
|
**(d)** **Impartiality Maintenance**: Maintain strict impartiality when mediating disputes or addressing community issues.
|
||||||
|
|
||||||
### 3.2 Organizational Representation Standards
|
### 3.2. Organizational Representation Standards
|
||||||
|
|
||||||
**(a)** **Continuous Representation**: Recognize that you represent the organization at all times during volunteer activities;
|
**(a)** **Continuous Representation**: Recognise that you represent the organisation at all times during volunteer activities;
|
||||||
|
|
||||||
**(b)** **Reputation Protection**: Avoid any actions, statements, or behaviors that could damage the organization's reputation;
|
**(b)** **Reputation Protection**: Avoid any actions, statements, or behaviours that could damage the organisation's reputation;
|
||||||
|
|
||||||
**(c)** **Position Separation**: Clearly separate personal opinions from official organizational positions in all communications;
|
**(c)** **Position Separation**: Clearly separate personal opinions from official organisational positions in all communications;
|
||||||
|
|
||||||
**(d)** **Professional Boundaries**: Maintain appropriate professional boundaries with community members and stakeholders.
|
**(d)** **Professional Boundaries**: Maintain appropriate professional boundaries with community members and stakeholders.
|
||||||
|
|
||||||
### 3.3 Collaboration and Teamwork Obligations
|
### 3.3. Collaboration and Teamwork Obligations
|
||||||
|
|
||||||
**(a)** **Cooperative Engagement**: Work cooperatively and constructively with other volunteers, staff, and organizational partners;
|
**(a)** **Cooperative Engagement**: Work cooperatively and constructively with other volunteers, staff, and organisational partners;
|
||||||
|
|
||||||
**(b)** **Information Sharing**: Share information and resources appropriately in accordance with organizational policies;
|
**(b)** **Information Sharing**: Share information and resources appropriately in accordance with organisational policies;
|
||||||
|
|
||||||
**(c)** **Team Decision Support**: Support team decisions and organizational policies even when you may personally disagree;
|
**(c)** **Team Decision Support**: Support team decisions and organisational policies even when you may personally disagree;
|
||||||
|
|
||||||
**(d)** **Feedback Excellence**: Provide constructive feedback and accept feedback gracefully as part of continuous improvement.
|
**(d)** **Feedback Excellence**: Provide constructive feedback and accept feedback gracefully as part of continuous improvement.
|
||||||
|
|
||||||
## 4. STRICTLY PROHIBITED CONDUCT
|
## 4. STRICTLY PROHIBITED CONDUCT
|
||||||
|
|
||||||
### 4.1 Harassment and Discrimination Prohibitions
|
### 4.1. Harassment and Discrimination Prohibitions
|
||||||
|
|
||||||
**(a)** **Zero Tolerance**: Harassment, discrimination, or bullying of any kind is strictly prohibited and subject to immediate disciplinary action;
|
**(a)** **Zero Tolerance**: Harassment, discrimination, or bullying of any kind is strictly prohibited and subject to immediate disciplinary action;
|
||||||
|
|
||||||
@@ -106,39 +106,39 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(d)** **Bystander Responsibility**: Volunteers are required to report witnessed harassment or discrimination.
|
**(d)** **Bystander Responsibility**: Volunteers are required to report witnessed harassment or discrimination.
|
||||||
|
|
||||||
### 4.2 Authority and Position Abuse
|
### 4.2. Authority and Position Abuse
|
||||||
|
|
||||||
**(a)** **Power Misuse**: Abuse of volunteer position, authority, or organizational access is strictly prohibited;
|
**(a)** **Power Misuse**: Abuse of volunteer position, authority, or organisational access is strictly prohibited;
|
||||||
|
|
||||||
**(b)** **Influence Exploitation**: Using organizational influence for personal gain or inappropriate purposes is forbidden;
|
**(b)** **Influence Exploitation**: Using organisational influence for personal gain or inappropriate purposes is forbidden;
|
||||||
|
|
||||||
**(c)** **Coercion Prevention**: Using position to coerce, manipulate, or inappropriately influence others is prohibited;
|
**(c)** **Coercion Prevention**: Using position to coerce, manipulate, or inappropriately influence others is prohibited;
|
||||||
|
|
||||||
**(d)** **Authority Misrepresentation**: Misrepresenting the scope or nature of your authority within the organization is forbidden.
|
**(d)** **Authority Misrepresentation**: Misrepresenting the scope or nature of your authority within the organisation is forbidden.
|
||||||
|
|
||||||
### 4.3 Confidentiality and Information Security Violations
|
### 4.3. Confidentiality and Information Security Violations
|
||||||
|
|
||||||
**(a)** **Information Protection**: Sharing confidential information without proper authorization is strictly prohibited;
|
**(a)** **Information Protection**: Sharing confidential information without proper authorisation is strictly prohibited;
|
||||||
|
|
||||||
**(b)** **Data Security**: Violations of organizational data security policies and procedures are forbidden;
|
**(b)** **Data Security**: Violations of organisational data security policies and procedures are forbidden;
|
||||||
|
|
||||||
**(c)** **Privacy Breaches**: Unauthorized disclosure of personal information about community members or colleagues is prohibited;
|
**(c)** **Privacy Breaches**: Unauthorized disclosure of personal information about community members or colleagues is prohibited;
|
||||||
|
|
||||||
**(d)** **Communication Security**: Sharing sensitive organizational communications outside authorized channels is forbidden.
|
**(d)** **Communication Security**: Sharing sensitive organisational communications outside authorised channels is forbidden.
|
||||||
|
|
||||||
### 4.4 Conflicts of Interest and Resource Misuse
|
### 4.4. Conflicts of Interest and Resource Misuse
|
||||||
|
|
||||||
**(a)** **Interest Conflicts**: Engaging in activities that create actual or apparent conflicts of interest is prohibited;
|
**(a)** **Interest Conflicts**: Engaging in activities that create actual or apparent conflicts of interest is prohibited;
|
||||||
|
|
||||||
**(b)** **Resource Misuse**: Using organizational resources, access, or information for personal benefit is strictly forbidden;
|
**(b)** **Resource Misuse**: Using organisational resources, access, or information for personal benefit is strictly forbidden;
|
||||||
|
|
||||||
**(c)** **Financial Impropriety**: Any form of financial impropriety or misuse of organizational funds or resources is prohibited;
|
**(c)** **Financial Impropriety**: Any form of financial impropriety or misuse of organisational funds or resources is prohibited;
|
||||||
|
|
||||||
**(d)** **Competitive Activities**: Engaging in activities that compete with or undermine organizational interests is forbidden.
|
**(d)** **Competitive Activities**: Engaging in activities that compete with or undermine organisational interests is forbidden.
|
||||||
|
|
||||||
## 5. REPORTING PROCEDURES AND ACCOUNTABILITY MECHANISMS
|
## 5. REPORTING PROCEDURES AND ACCOUNTABILITY MECHANISMS
|
||||||
|
|
||||||
### 5.1 Mandatory Reporting Obligations
|
### 5.1. Mandatory Reporting Obligations
|
||||||
|
|
||||||
**(a)** **Reporting Requirement**: All volunteers are required to report conduct violations they witness or experience;
|
**(a)** **Reporting Requirement**: All volunteers are required to report conduct violations they witness or experience;
|
||||||
|
|
||||||
@@ -146,9 +146,9 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(c)** **Anonymous Options**: Anonymous reporting options are available for sensitive situations;
|
**(c)** **Anonymous Options**: Anonymous reporting options are available for sensitive situations;
|
||||||
|
|
||||||
**(d)** **Retaliation Protection**: The organization prohibits retaliation against individuals who make good faith reports.
|
**(d)** **Retaliation Protection**: The organisation prohibits retaliation against individuals who make good faith reports.
|
||||||
|
|
||||||
### 5.2 Reporting Channels and Procedures
|
### 5.2. Reporting Channels and Procedures
|
||||||
|
|
||||||
**(a)** **Direct Supervision**: Report concerns to your direct supervisor or designated team leader;
|
**(a)** **Direct Supervision**: Report concerns to your direct supervisor or designated team leader;
|
||||||
|
|
||||||
@@ -156,19 +156,19 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(c)** **Crisis Response**: Contact crisis response coordinators immediately for urgent safety concerns;
|
**(c)** **Crisis Response**: Contact crisis response coordinators immediately for urgent safety concerns;
|
||||||
|
|
||||||
**(d)** **External Resources**: Access external resources for situations involving organizational leadership.
|
**(d)** **External Resources**: Access external resources for situations involving organisational leadership.
|
||||||
|
|
||||||
### 5.3 Investigation and Response Protocols
|
### 5.3. Investigation and Response Protocols
|
||||||
|
|
||||||
**(a)** **Prompt Investigation**: All reports will be investigated promptly, thoroughly, and confidentially;
|
**(a)** **Prompt Investigation**: All reports will be investigated promptly, thoroughly, and confidentially;
|
||||||
|
|
||||||
**(b)** **Due Process**: Investigation procedures will respect due process rights of all parties involved;
|
**(b)** **Due Process**: Investigation procedures will respect due process rights of all parties involved;
|
||||||
|
|
||||||
**(c)** **Documentation**: All investigations and responses will be properly documented in accordance with organizational policies;
|
**(c)** **Documentation**: All investigations and responses will be properly documented in accordance with organisational policies;
|
||||||
|
|
||||||
**(d)** **Communication**: Appropriate parties will be informed of investigation outcomes and any corrective actions.
|
**(d)** **Communication**: Appropriate parties will be informed of investigation outcomes and any corrective actions.
|
||||||
|
|
||||||
### 5.4 Disciplinary Consequences and Corrective Actions
|
### 5.4. Disciplinary Consequences and Corrective Actions
|
||||||
|
|
||||||
**(a)** **Progressive Discipline**: Violations may result in progressive disciplinary action appropriate to the severity of the violation;
|
**(a)** **Progressive Discipline**: Violations may result in progressive disciplinary action appropriate to the severity of the violation;
|
||||||
|
|
||||||
@@ -176,13 +176,13 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(c)** **Suspension**: Temporary suspension of volunteer privileges may be imposed pending investigation or as corrective action;
|
**(c)** **Suspension**: Temporary suspension of volunteer privileges may be imposed pending investigation or as corrective action;
|
||||||
|
|
||||||
**(d)** **Termination**: Permanent removal from volunteer programs may result from serious or repeated violations;
|
**(d)** **Termination**: Permanent removal from volunteer programmes may result from serious or repeated violations;
|
||||||
|
|
||||||
**(e)** **Legal Referral**: Serious violations may be referred to appropriate authorities for legal action.
|
**(e)** **Legal Referral**: Serious violations may be referred to appropriate authorities for legal action.
|
||||||
|
|
||||||
## 6. TRAINING, RESOURCES, AND SUPPORT SYSTEMS
|
## 6. TRAINING, RESOURCES, AND SUPPORT SYSTEMS
|
||||||
|
|
||||||
### 6.1 Mandatory Training Requirements
|
### 6.1. Mandatory Training Requirements
|
||||||
|
|
||||||
**(a)** **Initial Training**: All volunteers must complete professional conduct training before beginning volunteer activities;
|
**(a)** **Initial Training**: All volunteers must complete professional conduct training before beginning volunteer activities;
|
||||||
|
|
||||||
@@ -192,9 +192,9 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(d)** **Refresher Courses**: Periodic refresher training on professional conduct standards is required.
|
**(d)** **Refresher Courses**: Periodic refresher training on professional conduct standards is required.
|
||||||
|
|
||||||
### 6.2 Training Content and Curriculum
|
### 6.2. Training Content and Curriculum
|
||||||
|
|
||||||
**(a)** **Professional Development**: Comprehensive workshops on professional communication and behavior standards;
|
**(a)** **Professional Development**: Comprehensive workshops on professional communication and behaviour standards;
|
||||||
|
|
||||||
**(b)** **Conflict Resolution**: Training on effective conflict resolution and mediation techniques;
|
**(b)** **Conflict Resolution**: Training on effective conflict resolution and mediation techniques;
|
||||||
|
|
||||||
@@ -202,17 +202,17 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(d)** **Crisis Response**: Training on crisis response procedures and de-escalation techniques.
|
**(d)** **Crisis Response**: Training on crisis response procedures and de-escalation techniques.
|
||||||
|
|
||||||
### 6.3 Support System Infrastructure
|
### 6.3. Support System Infrastructure
|
||||||
|
|
||||||
**(a)** **Mentorship Programs**: Structured mentorship programs for new volunteers and ongoing professional development;
|
**(a)** **Mentorship Programmes**: Structured mentorship programmes for new volunteers and ongoing professional development;
|
||||||
|
|
||||||
**(b)** **Supervisory Support**: Regular check-ins with supervisors and team leaders for guidance and feedback;
|
**(b)** **Supervisory Support**: Regular check-ins with supervisors and team leaders for guidance and feedback;
|
||||||
|
|
||||||
**(c)** **Crisis Resources**: Immediate access to crisis response resources and emergency support systems;
|
**(c)** **Crisis Resources**: Immediate access to crisis response resources and emergency support systems;
|
||||||
|
|
||||||
**(d)** **Professional Development**: Ongoing opportunities for skill development and career advancement within the organization.
|
**(d)** **Professional Development**: Ongoing opportunities for skill development and career advancement within the organisation.
|
||||||
|
|
||||||
### 6.4 Resource Accessibility and Availability
|
### 6.4. Resource Accessibility and Availability
|
||||||
|
|
||||||
**(a)** **Equal Access**: All training and support resources are provided with equal access regardless of volunteer role or level;
|
**(a)** **Equal Access**: All training and support resources are provided with equal access regardless of volunteer role or level;
|
||||||
|
|
||||||
@@ -224,49 +224,49 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
## 7. POLICY MAINTENANCE AND CONTINUOUS IMPROVEMENT
|
## 7. POLICY MAINTENANCE AND CONTINUOUS IMPROVEMENT
|
||||||
|
|
||||||
### 7.1 Regular Policy Review and Updates
|
### 7.1. Regular Policy Review and Updates
|
||||||
|
|
||||||
**(a)** **Scheduled Reviews**: Comprehensive policy review and updates are conducted annually or as needed;
|
**(a)** **Scheduled Reviews**: Comprehensive policy review and updates are conducted annually or as needed;
|
||||||
|
|
||||||
**(b)** **Stakeholder Input**: Reviews include feedback from volunteers, community members, and organizational leadership;
|
**(b)** **Stakeholder Input**: Reviews include feedback from volunteers, community members, and organisational leadership;
|
||||||
|
|
||||||
**(c)** **Legal Compliance**: Updates ensure continued compliance with applicable laws and regulatory requirements;
|
**(c)** **Legal Compliance**: Updates ensure continued compliance with applicable laws and regulatory requirements;
|
||||||
|
|
||||||
**(d)** **Best Practices**: Policy updates incorporate evolving best practices in professional conduct and organizational management.
|
**(d)** **Best Practices**: Policy updates incorporate evolving best practices in professional conduct and organisational management.
|
||||||
|
|
||||||
### 7.2 Feedback Integration and Assessment
|
### 7.2. Feedback Integration and Assessment
|
||||||
|
|
||||||
**(a)** **Systematic Collection**: Regular, systematic collection of feedback from volunteers and community members;
|
**(a)** **Systematic Collection**: Regular, systematic collection of feedback from volunteers and community members;
|
||||||
|
|
||||||
**(b)** **Training Effectiveness**: Ongoing assessment of training program effectiveness and impact;
|
**(b)** **Training Effectiveness**: Ongoing assessment of training programme effectiveness and impact;
|
||||||
|
|
||||||
**(c)** **Implementation Analysis**: Analysis of policy implementation and compliance across the organization;
|
**(c)** **Implementation Analysis**: Analysis of policy implementation and compliance across the organisation;
|
||||||
|
|
||||||
**(d)** **Outcome Measurement**: Measurement of professional conduct standards on organizational culture and community experience.
|
**(d)** **Outcome Measurement**: Measurement of professional conduct standards on organisational culture and community experience.
|
||||||
|
|
||||||
### 7.3 Recognition and Accountability Excellence
|
### 7.3. Recognition and Accountability Excellence
|
||||||
|
|
||||||
**(a)** **Excellence Recognition**: Regular recognition of exemplary professional conduct and positive organizational contribution;
|
**(a)** **Excellence Recognition**: Regular recognition of exemplary professional conduct and positive organisational contribution;
|
||||||
|
|
||||||
**(b)** **Success Stories**: Documentation and sharing of professional conduct success stories and positive examples;
|
**(b)** **Success Stories**: Documentation and sharing of professional conduct success stories and positive examples;
|
||||||
|
|
||||||
**(c)** **Peer Recognition**: Systems for peer recognition of outstanding professional behavior;
|
**(c)** **Peer Recognition**: Systems for peer recognition of outstanding professional behaviour;
|
||||||
|
|
||||||
**(d)** **Leadership Development**: Recognition programs that support leadership development and career advancement.
|
**(d)** **Leadership Development**: Recognition programmes that support leadership development and career advancement.
|
||||||
|
|
||||||
### 7.4 Organizational Learning and Adaptation
|
### 7.4. Organizational Learning and Adaptation
|
||||||
|
|
||||||
**(a)** **Lessons Learned**: Integration of lessons learned from conduct issues and their resolution;
|
**(a)** **Lessons Learned**: Integration of lessons learned from conduct issues and their resolution;
|
||||||
|
|
||||||
**(b)** **Proactive Improvement**: Proactive identification and correction of potential professional conduct issues;
|
**(b)** **Proactive Improvement**: Proactive identification and correction of potential professional conduct issues;
|
||||||
|
|
||||||
**(c)** **Cultural Evolution**: Support for positive organizational culture evolution and professional standard enhancement;
|
**(c)** **Cultural Evolution**: Support for positive organisational culture evolution and professional standard enhancement;
|
||||||
|
|
||||||
**(d)** **Innovation Integration**: Integration of innovative approaches to professional conduct and organizational development.
|
**(d)** **Innovation Integration**: Integration of innovative approaches to professional conduct and organisational development.
|
||||||
|
|
||||||
## 8. POLICY IMPLEMENTATION AND COMPLIANCE
|
## 8. POLICY IMPLEMENTATION AND COMPLIANCE
|
||||||
|
|
||||||
### 8.1 Implementation Timeline and Requirements
|
### 8.1. Implementation Timeline and Requirements
|
||||||
|
|
||||||
**(a)** **Immediate Effect**: This policy takes immediate effect for all current and future volunteers;
|
**(a)** **Immediate Effect**: This policy takes immediate effect for all current and future volunteers;
|
||||||
|
|
||||||
@@ -276,11 +276,11 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
**(d)** **Compliance Monitoring**: Regular monitoring of compliance with professional conduct standards is required.
|
**(d)** **Compliance Monitoring**: Regular monitoring of compliance with professional conduct standards is required.
|
||||||
|
|
||||||
### 8.2 Legal Compliance and Integration
|
### 8.2. Legal Compliance and Integration
|
||||||
|
|
||||||
**(a)** **Legal Alignment**: This policy complies with all applicable employment, volunteer, and anti-discrimination laws;
|
**(a)** **Legal Alignment**: This policy complies with all applicable employment, volunteer, and anti-discrimination laws;
|
||||||
|
|
||||||
**(b)** **Policy Integration**: These standards integrate with and supplement other organizational policies and procedures;
|
**(b)** **Policy Integration**: These standards integrate with and supplement other organisational policies and procedures;
|
||||||
|
|
||||||
**(c)** **Regulatory Compliance**: Policy ensures compliance with relevant regulatory requirements and industry standards;
|
**(c)** **Regulatory Compliance**: Policy ensures compliance with relevant regulatory requirements and industry standards;
|
||||||
|
|
||||||
@@ -288,8 +288,5 @@ All volunteers representing our organization are required to maintain the highes
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Professional Conduct Policy establishes mandatory standards for volunteer behavior and organizational representation. All volunteers are required to comply with these standards and participate in related training and development programs. This policy works in conjunction with other organizational policies to ensure ethical, professional, and effective volunteer engagement. Regular review and updates ensure continued relevance and effectiveness.*
|
*This Professional Conduct Policy establishes mandatory standards for volunteer behaviour and organisational representation. All volunteers are required to comply with these standards and participate in related training and development programmes. This policy works in conjunction with other organisational policies to ensure ethical, professional, and effective volunteer engagement. Regular review and updates ensure continued relevance and effectiveness.*
|
||||||
|
|
||||||
**Document Version**: 1.0
|
|
||||||
**Last Updated**: 25 September 2025
|
|
||||||
**Next Review Date**: 25 September 2026
|
|
||||||
|
|||||||
+146
-146
@@ -4,13 +4,13 @@ title: Volunteer Roles and Opportunities
|
|||||||
|
|
||||||
## 1. Volunteer Framework and Structure
|
## 1. Volunteer Framework and Structure
|
||||||
|
|
||||||
### 1.1 Introduction to Volunteer Service
|
### 1.1. Introduction to Volunteer Service
|
||||||
|
|
||||||
This document provides comprehensive information about volunteer opportunities within our organisation, outlining available roles, responsibilities, selection processes, and support systems. All volunteer positions operate within our comprehensive legal and policy framework, particularly our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
This document provides comprehensive information about volunteer opportunities within our organisation, outlining available roles, responsibilities, selection processes, and support systems. All volunteer positions operate within our comprehensive legal and policy framework, particularly our Community Leadership and Governance Policy, which is incorporated herein by reference.
|
||||||
|
|
||||||
### 1.2 Volunteer Philosophy and Principles
|
### 1.2. Volunteer Philosophy and Principles
|
||||||
|
|
||||||
Our volunteer program is built on servant leadership principles:
|
Our volunteer programme is built on servant leadership principles:
|
||||||
|
|
||||||
**(a)** **Service-Oriented Leadership**: Volunteers serve the community rather than wielding authority for personal benefit;
|
**(a)** **Service-Oriented Leadership**: Volunteers serve the community rather than wielding authority for personal benefit;
|
||||||
|
|
||||||
@@ -22,15 +22,15 @@ Our volunteer program is built on servant leadership principles:
|
|||||||
|
|
||||||
**(e)** **Sustainable Engagement**: Volunteer roles are structured to prevent burnout and support long-term community service.
|
**(e)** **Sustainable Engagement**: Volunteer roles are structured to prevent burnout and support long-term community service.
|
||||||
|
|
||||||
### 1.3 Legal Framework Integration
|
### 1.3. Legal Framework Integration
|
||||||
|
|
||||||
All volunteer positions operate within our complete legal and policy framework, including Terms of Service, Community Policies, and specialised legal protections. **IMPORTANT: No volunteer position constitutes employment, and all service is provided on a voluntary basis without expectation of compensation.**
|
All volunteer positions operate within our complete legal and policy framework, including Terms of Service, Community Policies, and specialised legal protections. **IMPORTANT: No volunteer position constitutes employment, and all service is provided on a voluntary basis without expectation of compensation.**
|
||||||
|
|
||||||
## 2. Executive Leadership Volunteer Opportunities
|
## 2. Executive Leadership Volunteer Opportunities
|
||||||
|
|
||||||
### 2.1 Community Director (Executive Level)
|
### 2.1. Community Director (Executive Level)
|
||||||
|
|
||||||
#### 2.1.1 Role Overview
|
#### 2.1.1. Role Overview
|
||||||
The Community Director provides overall strategic direction and final decision-making authority for community operations, representing the highest level of volunteer leadership within our organisation.
|
The Community Director provides overall strategic direction and final decision-making authority for community operations, representing the highest level of volunteer leadership within our organisation.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -40,7 +40,7 @@ The Community Director provides overall strategic direction and final decision-m
|
|||||||
- Ensure leadership team accountability and performance standards
|
- Ensure leadership team accountability and performance standards
|
||||||
- Oversee crisis management and emergency response coordination
|
- Oversee crisis management and emergency response coordination
|
||||||
|
|
||||||
#### 2.1.2 Qualifications and Requirements
|
#### 2.1.2. Qualifications and Requirements
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Minimum two years of successful community leadership or relevant professional experience
|
- Minimum two years of successful community leadership or relevant professional experience
|
||||||
- Demonstrated expertise in organisational management and strategic planning
|
- Demonstrated expertise in organisational management and strategic planning
|
||||||
@@ -53,9 +53,9 @@ The Community Director provides overall strategic direction and final decision-m
|
|||||||
- Previous volunteer leadership roles with progressive responsibility increases
|
- Previous volunteer leadership roles with progressive responsibility increases
|
||||||
- Crisis management and conflict resolution expertise
|
- Crisis management and conflict resolution expertise
|
||||||
|
|
||||||
### 2.2 Deputy Director (Executive Level)
|
### 2.2. Deputy Director (Executive Level)
|
||||||
|
|
||||||
#### 2.2.1 Role Overview
|
#### 2.2.1. Role Overview
|
||||||
The Deputy Director supports the Community Director in strategic planning and implementation whilst serving as primary succession candidate for executive leadership.
|
The Deputy Director supports the Community Director in strategic planning and implementation whilst serving as primary succession candidate for executive leadership.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -64,16 +64,16 @@ The Deputy Director supports the Community Director in strategic planning and im
|
|||||||
- Coordinate leadership team activities and ensure effective communication
|
- Coordinate leadership team activities and ensure effective communication
|
||||||
- Serve as Community Director when needed and prepare for potential succession
|
- Serve as Community Director when needed and prepare for potential succession
|
||||||
|
|
||||||
#### 2.2.2 Selection and Development
|
#### 2.2.2. Selection and Development
|
||||||
**Selection Criteria:**
|
**Selection Criteria:**
|
||||||
- Demonstrated leadership excellence in operational or specialist leadership roles
|
- Demonstrated leadership excellence in operational or specialist leadership roles
|
||||||
- Strong strategic thinking and project management capabilities
|
- Strong strategic thinking and project management capabilities
|
||||||
- Commitment to community values and inclusive leadership principles
|
- Commitment to community values and inclusive leadership principles
|
||||||
- Ability to work collaboratively with diverse leadership team members
|
- Ability to work collaboratively with diverse leadership team members
|
||||||
|
|
||||||
### 2.3 Legal and Policy Advisor (Executive Level)
|
### 2.3. Legal and Policy Advisor (Executive Level)
|
||||||
|
|
||||||
#### 2.3.1 Role Overview
|
#### 2.3.1. Role Overview
|
||||||
The Legal and Policy Advisor provides oversight of legal compliance and policy development across all community operations, ensuring that all activities align with applicable laws, regulations, and best practices.
|
The Legal and Policy Advisor provides oversight of legal compliance and policy development across all community operations, ensuring that all activities align with applicable laws, regulations, and best practices.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -83,7 +83,7 @@ The Legal and Policy Advisor provides oversight of legal compliance and policy d
|
|||||||
- Coordinate with external legal counsel when necessary
|
- Coordinate with external legal counsel when necessary
|
||||||
- Maintain awareness of relevant laws and regulations affecting community operations
|
- Maintain awareness of relevant laws and regulations affecting community operations
|
||||||
|
|
||||||
#### 2.3.2 Qualifications and Requirements
|
#### 2.3.2. Qualifications and Requirements
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Legal education or extensive experience in policy development and compliance
|
- Legal education or extensive experience in policy development and compliance
|
||||||
- Strong understanding of relevant laws affecting online communities and digital platforms
|
- Strong understanding of relevant laws affecting online communities and digital platforms
|
||||||
@@ -92,15 +92,15 @@ The Legal and Policy Advisor provides oversight of legal compliance and policy d
|
|||||||
|
|
||||||
**Preferred Experience:**
|
**Preferred Experience:**
|
||||||
- Professional legal background or paralegal certification
|
- Professional legal background or paralegal certification
|
||||||
- Experience with non-profit governance and community organization law
|
- Experience with non-profit governance and community organisation law
|
||||||
- Knowledge of data protection, privacy, and digital rights legislation
|
- Knowledge of data protection, privacy, and digital rights legislation
|
||||||
- Previous experience in policy advisory or compliance roles
|
- Previous experience in policy advisory or compliance roles
|
||||||
|
|
||||||
## 3. Operational Leadership Volunteer Opportunities
|
## 3. Operational Leadership Volunteer Opportunities
|
||||||
|
|
||||||
### 3.1 Head Moderator (Operational Leadership)
|
### 3.1. Head Moderator (Operational Leadership)
|
||||||
|
|
||||||
#### 3.1.1 Role Overview
|
#### 3.1.1. Role Overview
|
||||||
The Head Moderator oversees the community moderation team, ensuring consistent application of community standards across all platforms and maintaining high-quality community safety and engagement.
|
The Head Moderator oversees the community moderation team, ensuring consistent application of community standards across all platforms and maintaining high-quality community safety and engagement.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -110,7 +110,7 @@ The Head Moderator oversees the community moderation team, ensuring consistent a
|
|||||||
- Handle escalated disciplinary matters and coordinate appeals processes
|
- Handle escalated disciplinary matters and coordinate appeals processes
|
||||||
- Maintain moderation transparency and accountability systems
|
- Maintain moderation transparency and accountability systems
|
||||||
|
|
||||||
#### 3.1.2 Qualifications and Selection
|
#### 3.1.2. Qualifications and Selection
|
||||||
**Essential Requirements:**
|
**Essential Requirements:**
|
||||||
- Minimum one year of successful community moderation experience
|
- Minimum one year of successful community moderation experience
|
||||||
- Strong understanding of community policies and inclusive enforcement practices
|
- Strong understanding of community policies and inclusive enforcement practices
|
||||||
@@ -123,9 +123,9 @@ The Head Moderator oversees the community moderation team, ensuring consistent a
|
|||||||
- Community management best practices and industry networking
|
- Community management best practices and industry networking
|
||||||
- Mental health first aid and trauma-informed practices certification
|
- Mental health first aid and trauma-informed practices certification
|
||||||
|
|
||||||
### 3.2 Community Manager (Operational Leadership)
|
### 3.2. Community Manager (Operational Leadership)
|
||||||
|
|
||||||
#### 3.2.1 Role Overview
|
#### 3.2.1. Role Overview
|
||||||
Community Managers focus on fostering positive community culture, coordinating activities, and serving as primary liaisons between community members and leadership.
|
Community Managers focus on fostering positive community culture, coordinating activities, and serving as primary liaisons between community members and leadership.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -133,34 +133,34 @@ Community Managers focus on fostering positive community culture, coordinating a
|
|||||||
- Coordinate community activities, discussions, and special initiatives
|
- Coordinate community activities, discussions, and special initiatives
|
||||||
- Serve as primary liaison between community members and leadership team
|
- Serve as primary liaison between community members and leadership team
|
||||||
- Monitor community health metrics and member satisfaction indicators
|
- Monitor community health metrics and member satisfaction indicators
|
||||||
- Implement community feedback programs and responsive improvement initiatives
|
- Implement community feedback programmes and responsive improvement initiatives
|
||||||
|
|
||||||
#### 3.2.2 Skills and Development
|
#### 3.2.2. Skills and Development
|
||||||
**Required Capabilities:**
|
**Required Capabilities:**
|
||||||
- Strong interpersonal communication and relationship-building skills
|
- Strong interpersonal communication and relationship-building skills
|
||||||
- Experience with event planning and community engagement activities
|
- Experience with event planning and community engagement activities
|
||||||
- Understanding of diverse community needs and inclusive programming
|
- Understanding of diverse community needs and inclusive programming
|
||||||
- Ability to collect and analyse community feedback for improvement planning
|
- Ability to collect and analyse community feedback for improvement planning
|
||||||
|
|
||||||
### 3.3 Technical Manager (Operational Leadership)
|
### 3.3. Technical Manager (Operational Leadership)
|
||||||
|
|
||||||
#### 3.3.1 Role Overview
|
#### 3.3.1. Role Overview
|
||||||
Technical Managers oversee day-to-day technical operations, coordinate development activities, and manage technical contributor teams, enabling Technical Administrators to focus on high-level infrastructure and strategic technical initiatives.
|
Technical Managers oversee day-to-day technical operations, coordinate development activities, and manage technical contributor teams, enabling Technical Administrators to focus on high-level infrastructure and strategic technical initiatives.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Oversee pull request reviews and coordinate code review processes
|
- Oversee pull request reviews and coordinate code review processes
|
||||||
- Manage issue triage, prioritization, and assignment to Technical Contributors
|
- Manage issue triage, prioritisation, and assignment to Technical Contributors
|
||||||
- Coordinate technical contributor team activities and project management
|
- Coordinate technical contributor team activities and project management
|
||||||
- Provide technical guidance and mentorship to Technical Contributors and community members
|
- Provide technical guidance and mentorship to Technical Contributors and community members
|
||||||
- Serve as primary liaison between Technical Administrators and Technical Contributors
|
- Serve as primary liaison between Technical Administrators and Technical Contributors
|
||||||
- Monitor technical project progress and ensure timely completion of development tasks
|
- Monitor technical project progress and ensure timely completion of development tasks
|
||||||
- Facilitate technical discussions and decision-making for community projects
|
- Facilitate technical discussions and decision-making for community projects
|
||||||
|
|
||||||
#### 3.3.2 Technical Leadership Requirements
|
#### 3.3.2. Technical Leadership Requirements
|
||||||
**Essential Management Skills:**
|
**Essential Management Skills:**
|
||||||
- Experience in technical project management and team coordination
|
- Experience in technical project management and team coordination
|
||||||
- Strong code review capabilities and software development best practices knowledge
|
- Strong code review capabilities and software development best practices knowledge
|
||||||
- Ability to triage and prioritize technical issues based on community impact and resources
|
- Ability to triage and prioritise technical issues based on community impact and resources
|
||||||
- Excellent communication skills for coordinating between technical and non-technical team members
|
- Excellent communication skills for coordinating between technical and non-technical team members
|
||||||
|
|
||||||
**Technical Competencies:**
|
**Technical Competencies:**
|
||||||
@@ -169,9 +169,9 @@ Technical Managers oversee day-to-day technical operations, coordinate developme
|
|||||||
- Experience with issue tracking systems and project management tools
|
- Experience with issue tracking systems and project management tools
|
||||||
- Knowledge of software testing, deployment, and quality assurance practices
|
- Knowledge of software testing, deployment, and quality assurance practices
|
||||||
|
|
||||||
### 3.4 Technical Administrator (Operational Leadership)
|
### 3.4. Technical Administrator (Operational Leadership)
|
||||||
|
|
||||||
#### 3.4.1 Role Overview
|
#### 3.4.1. Role Overview
|
||||||
Technical Administrators manage platform infrastructure, security systems, and high-level technical strategy that support community operations and member experience.
|
Technical Administrators manage platform infrastructure, security systems, and high-level technical strategy that support community operations and member experience.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -182,7 +182,7 @@ Technical Administrators manage platform infrastructure, security systems, and h
|
|||||||
- Technical policy development and compliance oversight
|
- Technical policy development and compliance oversight
|
||||||
- Strategic technical training and support for leadership team members
|
- Strategic technical training and support for leadership team members
|
||||||
|
|
||||||
#### 3.4.2 Technical Requirements
|
#### 3.4.2. Technical Requirements
|
||||||
**Essential Technical Skills:**
|
**Essential Technical Skills:**
|
||||||
- Advanced platform administration experience (Discord, forums, databases, cloud infrastructure)
|
- Advanced platform administration experience (Discord, forums, databases, cloud infrastructure)
|
||||||
- Comprehensive security and privacy protection implementation knowledge
|
- Comprehensive security and privacy protection implementation knowledge
|
||||||
@@ -191,9 +191,9 @@ Technical Administrators manage platform infrastructure, security systems, and h
|
|||||||
|
|
||||||
## 4. Specialist Leadership Volunteer Opportunities
|
## 4. Specialist Leadership Volunteer Opportunities
|
||||||
|
|
||||||
### 4.1 Accessibility Coordinator (Specialist Leadership)
|
### 4.1. Accessibility Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.1.1 Role Overview
|
#### 4.1.1. Role Overview
|
||||||
The Accessibility Coordinator ensures that all community systems, activities, and policies promote inclusion and accommodate diverse accessibility needs.
|
The Accessibility Coordinator ensures that all community systems, activities, and policies promote inclusion and accommodate diverse accessibility needs.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -203,7 +203,7 @@ The Accessibility Coordinator ensures that all community systems, activities, an
|
|||||||
- Evaluate platform accessibility and recommend system improvements
|
- Evaluate platform accessibility and recommend system improvements
|
||||||
- Serve as primary contact for accessibility-related concerns and accommodation requests
|
- Serve as primary contact for accessibility-related concerns and accommodation requests
|
||||||
|
|
||||||
#### 4.1.2 Expertise and Training
|
#### 4.1.2. Expertise and Training
|
||||||
**Required Knowledge:**
|
**Required Knowledge:**
|
||||||
- Understanding of accessibility principles and universal design concepts
|
- Understanding of accessibility principles and universal design concepts
|
||||||
- Familiarity with assistive technologies and accommodation strategies
|
- Familiarity with assistive technologies and accommodation strategies
|
||||||
@@ -211,32 +211,32 @@ The Accessibility Coordinator ensures that all community systems, activities, an
|
|||||||
- Knowledge of legal accessibility requirements and best practices
|
- Knowledge of legal accessibility requirements and best practices
|
||||||
|
|
||||||
**Ongoing Development:**
|
**Ongoing Development:**
|
||||||
- Accessibility certification programs and continuing education
|
- Accessibility certification programmes and continuing education
|
||||||
- Collaboration with external accessibility experts and organisations
|
- Collaboration with external accessibility experts and organisations
|
||||||
- Training in emerging assistive technologies and inclusive design innovations
|
- Training in emerging assistive technologies and inclusive design innovations
|
||||||
|
|
||||||
### 4.2 Events Coordinator (Specialist Leadership)
|
### 4.2. Events Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.2.1 Role Overview
|
#### 4.2.1. Role Overview
|
||||||
Events Coordinators plan and execute community activities, celebrations, and educational programming that strengthen community bonds and provide value to members.
|
Events Coordinators plan and execute community activities, celebrations, and educational programming that strengthen community bonds and provide value to members.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Plan and coordinate community events, celebrations, and educational programs
|
- Plan and coordinate community events, celebrations, and educational programmes
|
||||||
- Manage event logistics including accessibility accommodations and timezone considerations
|
- Manage event logistics including accessibility accommodations and timezone considerations
|
||||||
- Coordinate with other leadership team members for integrated programming
|
- Coordinate with other leadership team members for integrated programming
|
||||||
- Evaluate event success and gather feedback for continuous improvement
|
- Evaluate event success and gather feedback for continuous improvement
|
||||||
- Develop partnerships with external organisations for enhanced programming opportunities
|
- Develop partnerships with external organisations for enhanced programming opportunities
|
||||||
|
|
||||||
#### 4.2.2 Skills Development
|
#### 4.2.2. Skills Development
|
||||||
**Event Planning Capabilities:**
|
**Event Planning Capabilities:**
|
||||||
- Experience with inclusive event planning and accessibility accommodation
|
- Experience with inclusive event planning and accessibility accommodation
|
||||||
- Understanding of diverse community interests and engagement preferences
|
- Understanding of diverse community interests and engagement preferences
|
||||||
- Project management skills and ability to coordinate multiple stakeholders
|
- Project management skills and ability to coordinate multiple stakeholders
|
||||||
- Cultural sensitivity and awareness of diverse celebration practices
|
- Cultural sensitivity and awareness of diverse celebration practices
|
||||||
|
|
||||||
### 4.3 Crisis Response Coordinator (Specialist Leadership)
|
### 4.3. Crisis Response Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.3.1 Role Overview
|
#### 4.3.1. Role Overview
|
||||||
The Crisis Response Coordinator develops and manages crisis response protocols, coordinates mental health support, and leads emergency response efforts to ensure community safety and well-being.
|
The Crisis Response Coordinator develops and manages crisis response protocols, coordinates mental health support, and leads emergency response efforts to ensure community safety and well-being.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -247,7 +247,7 @@ The Crisis Response Coordinator develops and manages crisis response protocols,
|
|||||||
- Maintain relationships with external mental health and emergency services
|
- Maintain relationships with external mental health and emergency services
|
||||||
- Oversee post-crisis community healing and support processes
|
- Oversee post-crisis community healing and support processes
|
||||||
|
|
||||||
#### 4.3.2 Qualifications and Training
|
#### 4.3.2. Qualifications and Training
|
||||||
**Essential Skills:**
|
**Essential Skills:**
|
||||||
- Experience in crisis intervention, mental health support, or emergency response
|
- Experience in crisis intervention, mental health support, or emergency response
|
||||||
- Strong emotional intelligence and ability to remain calm under pressure
|
- Strong emotional intelligence and ability to remain calm under pressure
|
||||||
@@ -259,9 +259,9 @@ The Crisis Response Coordinator develops and manages crisis response protocols,
|
|||||||
- Collaboration with mental health professionals and emergency services
|
- Collaboration with mental health professionals and emergency services
|
||||||
- Training in community trauma response and healing practices
|
- Training in community trauma response and healing practices
|
||||||
|
|
||||||
### 4.4 Communications and Outreach Coordinator (Specialist Leadership)
|
### 4.4. Communications and Outreach Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.4.1 Role Overview
|
#### 4.4.1. Role Overview
|
||||||
The Communications and Outreach Coordinator manages external communications, public relations, and community messaging to ensure consistent and effective communication across all platforms and with external partners.
|
The Communications and Outreach Coordinator manages external communications, public relations, and community messaging to ensure consistent and effective communication across all platforms and with external partners.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -273,58 +273,58 @@ The Communications and Outreach Coordinator manages external communications, pub
|
|||||||
- Develop and maintain community brand voice and messaging guidelines
|
- Develop and maintain community brand voice and messaging guidelines
|
||||||
- Coordinate crisis communications and public response strategies
|
- Coordinate crisis communications and public response strategies
|
||||||
|
|
||||||
#### 4.4.2 Skills and Development
|
#### 4.4.2. Skills and Development
|
||||||
**Required Capabilities:**
|
**Required Capabilities:**
|
||||||
- Strong writing and communication skills across multiple platforms and mediums
|
- Strong writing and communication skills across multiple platforms and mediums
|
||||||
- Experience with social media management and digital marketing
|
- Experience with social media management and digital marketing
|
||||||
- Understanding of public relations principles and crisis communications
|
- Understanding of public relations principles and crisis communications
|
||||||
- Project management skills for coordinating complex communication campaigns
|
- Project management skills for coordinating complex communication campaigns
|
||||||
|
|
||||||
### 4.5 Training and Development Coordinator (Specialist Leadership)
|
### 4.5. Training and Development Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.5.1 Role Overview
|
#### 4.5.1. Role Overview
|
||||||
The Training and Development Coordinator oversees comprehensive training programs, professional development opportunities, and educational initiatives for leaders and community members.
|
The Training and Development Coordinator oversees comprehensive training programmes, professional development opportunities, and educational initiatives for leaders and community members.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Develop and maintain comprehensive training curricula for all leadership roles
|
- Develop and maintain comprehensive training curricula for all leadership roles
|
||||||
- Coordinate onboarding programs for new leaders and community members
|
- Coordinate onboarding programmes for new leaders and community members
|
||||||
- Manage mentorship program structure, matching, and effectiveness monitoring
|
- Manage mentorship programme structure, matching, and effectiveness monitoring
|
||||||
- Oversee professional development opportunities and educational resources
|
- Oversee professional development opportunities and educational resources
|
||||||
- Ensure consistent training standards and quality across all programs
|
- Ensure consistent training standards and quality across all programmes
|
||||||
- Coordinate with external training providers and professional development opportunities
|
- Coordinate with external training providers and professional development opportunities
|
||||||
- Evaluate training effectiveness and implement continuous improvements
|
- Evaluate training effectiveness and implement continuous improvements
|
||||||
|
|
||||||
#### 4.5.2 Educational Expertise
|
#### 4.5.2. Educational Expertise
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Experience in curriculum development, training design, or educational program management
|
- Experience in curriculum development, training design, or educational programme management
|
||||||
- Strong understanding of adult learning principles and training methodologies
|
- Strong understanding of adult learning principles and training methodologies
|
||||||
- Ability to assess training needs and develop appropriate learning solutions
|
- Ability to assess training needs and develop appropriate learning solutions
|
||||||
- Project management skills for coordinating multiple training initiatives
|
- Project management skills for coordinating multiple training initiatives
|
||||||
|
|
||||||
### 4.6 Partnership and Collaboration Coordinator (Specialist Leadership)
|
### 4.6. Partnership and Collaboration Coordinator (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.6.1 Role Overview
|
#### 4.6.1. Role Overview
|
||||||
The Partnership and Collaboration Coordinator manages relationships with external organizations, coordinates collaborative projects, and develops strategic partnerships that benefit the community.
|
The Partnership and Collaboration Coordinator manages relationships with external organisations, coordinates collaborative projects, and develops strategic partnerships that benefit the community.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Manage relationships with other communities, organizations, and external partners
|
- Manage relationships with other communities, organisations, and external partners
|
||||||
- Coordinate collaborative projects and cross-community initiatives
|
- Coordinate collaborative projects and cross-community initiatives
|
||||||
- Oversee guest speaker programs and external educational opportunities
|
- Oversee guest speaker programmes and external educational opportunities
|
||||||
- Manage sponsorship agreements and partnership development
|
- Manage sponsorship agreements and partnership development
|
||||||
- Facilitate inter-community events and collaborative activities
|
- Facilitate inter-community events and collaborative activities
|
||||||
- Develop and maintain partnership agreements and memoranda of understanding
|
- Develop and maintain partnership agreements and memoranda of understanding
|
||||||
- Represent the community in external collaborative forums and networks
|
- Represent the community in external collaborative forums and networks
|
||||||
|
|
||||||
#### 4.6.2 Partnership Development Skills
|
#### 4.6.2. Partnership Development Skills
|
||||||
**Required Experience:**
|
**Required Experience:**
|
||||||
- Experience in partnership development, relationship management, or business development
|
- Experience in partnership development, relationship management, or business development
|
||||||
- Strong networking and relationship-building capabilities
|
- Strong networking and relationship-building capabilities
|
||||||
- Understanding of collaboration principles and partnership best practices
|
- Understanding of collaboration principles and partnership best practices
|
||||||
- Negotiation skills and ability to develop mutually beneficial agreements
|
- Negotiation skills and ability to develop mutually beneficial agreements
|
||||||
|
|
||||||
### 4.7 Support Team Leader (Specialist Leadership)
|
### 4.7. Support Team Leader (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.7.1 Role Overview
|
#### 4.7.1. Role Overview
|
||||||
The Support Team Leader oversees and coordinates all community support operations, ensuring high-quality member assistance and managing the support team effectively.
|
The Support Team Leader oversees and coordinates all community support operations, ensuring high-quality member assistance and managing the support team effectively.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -335,20 +335,20 @@ The Support Team Leader oversees and coordinates all community support operation
|
|||||||
- Handle escalated support issues and complex member concerns requiring leadership intervention
|
- Handle escalated support issues and complex member concerns requiring leadership intervention
|
||||||
- Coordinate support team scheduling and coverage to ensure consistent availability
|
- Coordinate support team scheduling and coverage to ensure consistent availability
|
||||||
- Collaborate with other leadership roles to identify support needs and resource requirements
|
- Collaborate with other leadership roles to identify support needs and resource requirements
|
||||||
- Implement support team improvements and process optimizations based on feedback and analytics
|
- Implement support team improvements and process optimisations based on feedback and analytics
|
||||||
- Serve as primary liaison between support team and executive/operational leadership
|
- Serve as primary liaison between support team and executive/operational leadership
|
||||||
- Manage support team knowledge base and ensure consistent information sharing
|
- Manage support team knowledge base and ensure consistent information sharing
|
||||||
|
|
||||||
#### 4.7.2 Leadership and Management Skills
|
#### 4.7.2. Leadership and Management Skills
|
||||||
**Essential Capabilities:**
|
**Essential Capabilities:**
|
||||||
- Experience in team leadership, customer service management, or support operations
|
- Experience in team leadership, customer service management, or support operations
|
||||||
- Strong analytical skills for monitoring support metrics and identifying improvements
|
- Strong analytical skills for monitoring support metrics and identifying improvements
|
||||||
- Excellent communication and training abilities for team development
|
- Excellent communication and training abilities for team development
|
||||||
- Understanding of support best practices and quality assurance principles
|
- Understanding of support best practices and quality assurance principles
|
||||||
|
|
||||||
### 4.8 Community Growth Specialist (Specialist Leadership)
|
### 4.8. Community Growth Specialist (Specialist Leadership)
|
||||||
|
|
||||||
#### 4.8.1 Role Overview
|
#### 4.8.1. Role Overview
|
||||||
The Community Growth Specialist develops and implements comprehensive growth strategies focused on member recruitment, retention, and community expansion initiatives.
|
The Community Growth Specialist develops and implements comprehensive growth strategies focused on member recruitment, retention, and community expansion initiatives.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -356,15 +356,15 @@ The Community Growth Specialist develops and implements comprehensive growth str
|
|||||||
- Analyse community growth metrics, member acquisition trends, and retention patterns
|
- Analyse community growth metrics, member acquisition trends, and retention patterns
|
||||||
- Design and execute outreach campaigns to attract new members from target demographics
|
- Design and execute outreach campaigns to attract new members from target demographics
|
||||||
- Coordinate with Communications and Outreach Coordinator on growth-focused messaging and content
|
- Coordinate with Communications and Outreach Coordinator on growth-focused messaging and content
|
||||||
- Implement member retention programs and initiatives to reduce community churn
|
- Implement member retention programmes and initiatives to reduce community churn
|
||||||
- Identify and develop community growth opportunities through partnerships and collaborations
|
- Identify and develop community growth opportunities through partnerships and collaborations
|
||||||
- Monitor and optimize member onboarding processes to improve new member experience and retention
|
- Monitor and optimise member onboarding processes to improve new member experience and retention
|
||||||
- Conduct market research and competitive analysis to identify growth opportunities
|
- Conduct market research and competitive analysis to identify growth opportunities
|
||||||
- Create and manage referral programs and member advocacy initiatives
|
- Create and manage referral programmes and member advocacy initiatives
|
||||||
- Track and report on key growth metrics including member acquisition, retention, and lifetime value
|
- Track and report on key growth metrics including member acquisition, retention, and lifetime value
|
||||||
- Collaborate with Events Coordinator to design growth-focused community activities and engagement programs
|
- Collaborate with Events Coordinator to design growth-focused community activities and engagement programmes
|
||||||
|
|
||||||
#### 4.8.2 Growth and Analytics Expertise
|
#### 4.8.2. Growth and Analytics Expertise
|
||||||
**Required Skills:**
|
**Required Skills:**
|
||||||
- Experience in community growth, marketing, or business development
|
- Experience in community growth, marketing, or business development
|
||||||
- Strong analytical skills and experience with data analysis and metrics tracking
|
- Strong analytical skills and experience with data analysis and metrics tracking
|
||||||
@@ -373,9 +373,9 @@ The Community Growth Specialist develops and implements comprehensive growth str
|
|||||||
|
|
||||||
## 5. Volunteer Leadership Opportunities
|
## 5. Volunteer Leadership Opportunities
|
||||||
|
|
||||||
### 5.1 Community Moderators
|
### 5.1. Community Moderators
|
||||||
|
|
||||||
#### 5.1.1 Role Overview
|
#### 5.1.1. Role Overview
|
||||||
Community Moderators provide front-line community support, enforce community standards, and ensure safe, welcoming environments for all community members.
|
Community Moderators provide front-line community support, enforce community standards, and ensure safe, welcoming environments for all community members.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -385,7 +385,7 @@ Community Moderators provide front-line community support, enforce community sta
|
|||||||
- Support new member integration and community onboarding processes
|
- Support new member integration and community onboarding processes
|
||||||
- Participate in moderation team collaboration and continuous improvement efforts
|
- Participate in moderation team collaboration and continuous improvement efforts
|
||||||
|
|
||||||
#### 5.1.2 Training and Support
|
#### 5.1.2. Training and Support
|
||||||
**Mandatory Training Components:**
|
**Mandatory Training Components:**
|
||||||
- Community values and policy framework comprehensive orientation
|
- Community values and policy framework comprehensive orientation
|
||||||
- Moderation techniques and de-escalation skill development
|
- Moderation techniques and de-escalation skill development
|
||||||
@@ -395,12 +395,12 @@ Community Moderators provide front-line community support, enforce community sta
|
|||||||
**Ongoing Support Systems:**
|
**Ongoing Support Systems:**
|
||||||
- Peer mentorship with experienced moderators
|
- Peer mentorship with experienced moderators
|
||||||
- Regular team meetings and collaboration opportunities
|
- Regular team meetings and collaboration opportunities
|
||||||
- Professional development and skill enhancement programs
|
- Professional development and skill enhancement programmes
|
||||||
- Burnout prevention resources and wellness support systems
|
- Burnout prevention resources and wellness support systems
|
||||||
|
|
||||||
### 5.2 Community Mentors
|
### 5.2. Community Mentors
|
||||||
|
|
||||||
#### 5.2.1 Role Overview
|
#### 5.2.1. Role Overview
|
||||||
Community Mentors provide guidance and support to new community members, helping them integrate successfully into community culture and participate meaningfully in community activities.
|
Community Mentors provide guidance and support to new community members, helping them integrate successfully into community culture and participate meaningfully in community activities.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -408,9 +408,9 @@ Community Mentors provide guidance and support to new community members, helping
|
|||||||
- Provide ongoing guidance and support during new member integration periods
|
- Provide ongoing guidance and support during new member integration periods
|
||||||
- Answer questions about community activities, policies, and participation opportunities
|
- Answer questions about community activities, policies, and participation opportunities
|
||||||
- Connect new members with relevant resources, tools, and community connections
|
- Connect new members with relevant resources, tools, and community connections
|
||||||
- Participate in mentor training and peer support programs
|
- Participate in mentor training and peer support programmes
|
||||||
|
|
||||||
#### 5.2.2 Mentor Development
|
#### 5.2.2. Mentor Development
|
||||||
**Qualification Requirements:**
|
**Qualification Requirements:**
|
||||||
- Minimum six months of positive community participation and engagement
|
- Minimum six months of positive community participation and engagement
|
||||||
- Demonstrated understanding of community values and inclusive practices
|
- Demonstrated understanding of community values and inclusive practices
|
||||||
@@ -421,11 +421,11 @@ Community Mentors provide guidance and support to new community members, helping
|
|||||||
- Peer support training and inclusive communication skill development
|
- Peer support training and inclusive communication skill development
|
||||||
- Cultural competency and sensitivity training for diverse member support
|
- Cultural competency and sensitivity training for diverse member support
|
||||||
- Regular mentor coordination meetings and experience sharing sessions
|
- Regular mentor coordination meetings and experience sharing sessions
|
||||||
- Recognition and appreciation programs celebrating mentor contributions
|
- Recognition and appreciation programmes celebrating mentor contributions
|
||||||
|
|
||||||
### 5.3 Subject Matter Experts
|
### 5.3. Subject Matter Experts
|
||||||
|
|
||||||
#### 5.3.1 Role Overview
|
#### 5.3.1. Role Overview
|
||||||
Subject Matter Experts provide specialised knowledge and educational support in specific areas relevant to community interests and activities.
|
Subject Matter Experts provide specialised knowledge and educational support in specific areas relevant to community interests and activities.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -435,7 +435,7 @@ Subject Matter Experts provide specialised knowledge and educational support in
|
|||||||
- Participate in community programming and educational initiative development
|
- Participate in community programming and educational initiative development
|
||||||
- Collaborate with other volunteers to integrate expertise into community activities
|
- Collaborate with other volunteers to integrate expertise into community activities
|
||||||
|
|
||||||
#### 5.3.2 Expertise Areas
|
#### 5.3.2. Expertise Areas
|
||||||
**Technical Specialties:**
|
**Technical Specialties:**
|
||||||
- Programming languages and software development
|
- Programming languages and software development
|
||||||
- System administration and cybersecurity
|
- System administration and cybersecurity
|
||||||
@@ -446,11 +446,11 @@ Subject Matter Experts provide specialised knowledge and educational support in
|
|||||||
- Conflict resolution and mediation
|
- Conflict resolution and mediation
|
||||||
- Mental health support and wellness resources
|
- Mental health support and wellness resources
|
||||||
- Cultural competency and diversity initiatives
|
- Cultural competency and diversity initiatives
|
||||||
- Educational program development and facilitation
|
- Educational programme development and facilitation
|
||||||
|
|
||||||
### 5.4 Technical Contributors
|
### 5.4. Technical Contributors
|
||||||
|
|
||||||
#### 5.4.1 Role Overview
|
#### 5.4.1. Role Overview
|
||||||
Technical Contributors provide development support, code contributions, and technical expertise to improve community platforms, tools, and resources while participating in community activities and technical discussions.
|
Technical Contributors provide development support, code contributions, and technical expertise to improve community platforms, tools, and resources while participating in community activities and technical discussions.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -461,7 +461,7 @@ Technical Contributors provide development support, code contributions, and tech
|
|||||||
- Support community technical education and knowledge sharing initiatives
|
- Support community technical education and knowledge sharing initiatives
|
||||||
- Collaborate with Technical Administrators on platform improvements and maintenance
|
- Collaborate with Technical Administrators on platform improvements and maintenance
|
||||||
|
|
||||||
#### 5.4.2 Technical Expertise Areas
|
#### 5.4.2. Technical Expertise Areas
|
||||||
|
|
||||||
**Development Specialties:**
|
**Development Specialties:**
|
||||||
- Web development (frontend and backend technologies)
|
- Web development (frontend and backend technologies)
|
||||||
@@ -477,7 +477,7 @@ Technical Contributors provide development support, code contributions, and tech
|
|||||||
- Accessibility implementation and testing
|
- Accessibility implementation and testing
|
||||||
- Security assessment and improvement recommendations
|
- Security assessment and improvement recommendations
|
||||||
|
|
||||||
#### 5.4.3 Qualifications and Selection
|
#### 5.4.3. Qualifications and Selection
|
||||||
|
|
||||||
**Essential Technical Skills:**
|
**Essential Technical Skills:**
|
||||||
- Proficiency in relevant programming languages and development frameworks
|
- Proficiency in relevant programming languages and development frameworks
|
||||||
@@ -491,9 +491,9 @@ Technical Contributors provide development support, code contributions, and tech
|
|||||||
- Collaborative approach to development and willingness to mentor others
|
- Collaborative approach to development and willingness to mentor others
|
||||||
- Understanding of accessibility principles and inclusive design practices
|
- Understanding of accessibility principles and inclusive design practices
|
||||||
|
|
||||||
### 5.5 Guild Wars 2 Leader
|
### 5.5. Guild Wars 2 Leader
|
||||||
|
|
||||||
#### 5.5.1 Role Overview
|
#### 5.5.1. Role Overview
|
||||||
Guild Wars 2 Leaders provide strategic leadership and direction for Guild Wars 2 community activities, coordinating guild operations and representing the community in the game environment.
|
Guild Wars 2 Leaders provide strategic leadership and direction for Guild Wars 2 community activities, coordinating guild operations and representing the community in the game environment.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -505,16 +505,16 @@ Guild Wars 2 Leaders provide strategic leadership and direction for Guild Wars 2
|
|||||||
- Plan and execute large-scale guild events, missions, and competitive activities
|
- Plan and execute large-scale guild events, missions, and competitive activities
|
||||||
- Monitor guild health, member satisfaction, and retention within the game environment
|
- Monitor guild health, member satisfaction, and retention within the game environment
|
||||||
|
|
||||||
#### 5.5.2 Gaming Leadership Requirements
|
#### 5.5.2. Gaming Leadership Requirements
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Extensive Guild Wars 2 gameplay experience and deep understanding of game mechanics
|
- Extensive Guild Wars 2 gameplay experience and deep understanding of game mechanics
|
||||||
- Proven leadership experience within gaming communities or guild environments
|
- Proven leadership experience within gaming communities or guild environments
|
||||||
- Strong organizational skills for coordinating guild activities and events
|
- Strong organisational skills for coordinating guild activities and events
|
||||||
- Excellent communication skills for managing diverse guild member needs
|
- Excellent communication skills for managing diverse guild member needs
|
||||||
|
|
||||||
### 5.6 Guild Wars 2 Officer
|
### 5.6. Guild Wars 2 Officer
|
||||||
|
|
||||||
#### 5.6.1 Role Overview
|
#### 5.6.1. Role Overview
|
||||||
Guild Wars 2 Officers support the Guild Wars 2 Leader in daily guild operations, providing member coordination and assistance while helping to maintain a positive guild environment.
|
Guild Wars 2 Officers support the Guild Wars 2 Leader in daily guild operations, providing member coordination and assistance while helping to maintain a positive guild environment.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -526,16 +526,16 @@ Guild Wars 2 Officers support the Guild Wars 2 Leader in daily guild operations,
|
|||||||
- Maintain guild resources, including banks, halls, and shared assets
|
- Maintain guild resources, including banks, halls, and shared assets
|
||||||
- Coordinate with other officers to ensure consistent coverage and support for guild members
|
- Coordinate with other officers to ensure consistent coverage and support for guild members
|
||||||
|
|
||||||
#### 5.6.2 Officer Development
|
#### 5.6.2. Officer Development
|
||||||
**Required Skills:**
|
**Required Skills:**
|
||||||
- Solid Guild Wars 2 gameplay experience and familiarity with guild systems
|
- Solid Guild Wars 2 gameplay experience and familiarity with guild systems
|
||||||
- Strong interpersonal skills and patience for helping new members
|
- Strong interpersonal skills and patience for helping new members
|
||||||
- Ability to organize and lead small group activities and events
|
- Ability to organise and lead small group activities and events
|
||||||
- Understanding of conflict resolution and community moderation principles
|
- Understanding of conflict resolution and community moderation principles
|
||||||
|
|
||||||
### 5.7 Quality Assurance Coordinator
|
### 5.7. Quality Assurance Coordinator
|
||||||
|
|
||||||
#### 5.7.1 Role Overview
|
#### 5.7.1. Role Overview
|
||||||
Quality Assurance Coordinators ensure the quality and consistency of community platforms, resources, and documentation through comprehensive testing and review processes.
|
Quality Assurance Coordinators ensure the quality and consistency of community platforms, resources, and documentation through comprehensive testing and review processes.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -547,16 +547,16 @@ Quality Assurance Coordinators ensure the quality and consistency of community p
|
|||||||
- Develop and maintain quality assurance standards and testing procedures
|
- Develop and maintain quality assurance standards and testing procedures
|
||||||
- Collaborate with Technical Contributors and Technical Administrators on issue resolution
|
- Collaborate with Technical Contributors and Technical Administrators on issue resolution
|
||||||
|
|
||||||
#### 5.7.2 Quality Assurance Skills
|
#### 5.7.2. Quality Assurance Skills
|
||||||
**Essential Capabilities:**
|
**Essential Capabilities:**
|
||||||
- Experience with software testing, quality assurance, or documentation review
|
- Experience with software testing, quality assurance, or documentation review
|
||||||
- Strong attention to detail and systematic approach to identifying issues
|
- Strong attention to detail and systematic approach to identifying issues
|
||||||
- Understanding of accessibility standards and testing methodologies
|
- Understanding of accessibility standards and testing methodologies
|
||||||
- Analytical skills for documenting and tracking quality metrics
|
- Analytical skills for documenting and tracking quality metrics
|
||||||
|
|
||||||
### 5.8 Data and Analytics Coordinator
|
### 5.8. Data and Analytics Coordinator
|
||||||
|
|
||||||
#### 5.8.1 Role Overview
|
#### 5.8.1. Role Overview
|
||||||
Data and Analytics Coordinators collect and analyze community engagement data to provide insights that support leadership decision-making and community improvement initiatives.
|
Data and Analytics Coordinators collect and analyze community engagement data to provide insights that support leadership decision-making and community improvement initiatives.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -565,21 +565,21 @@ Data and Analytics Coordinators collect and analyze community engagement data to
|
|||||||
- Manage community surveys and feedback analysis for leadership decision-making
|
- Manage community surveys and feedback analysis for leadership decision-making
|
||||||
- Support leadership team with data insights and trend identification
|
- Support leadership team with data insights and trend identification
|
||||||
- Maintain privacy-compliant data collection and analysis practices
|
- Maintain privacy-compliant data collection and analysis practices
|
||||||
- Develop dashboards and visualization tools for community metrics monitoring
|
- Develop dashboards and visualisation tools for community metrics monitoring
|
||||||
- Coordinate with other leadership roles to identify key performance indicators and success metrics
|
- Coordinate with other leadership roles to identify key performance indicators and success metrics
|
||||||
|
|
||||||
#### 5.8.2 Analytics and Research Skills
|
#### 5.8.2. Analytics and Research Skills
|
||||||
**Required Expertise:**
|
**Required Expertise:**
|
||||||
- Experience with data analysis, statistics, or research methodologies
|
- Experience with data analysis, statistics, or research methodologies
|
||||||
- Proficiency with data analysis tools and visualization software
|
- Proficiency with data analysis tools and visualisation software
|
||||||
- Understanding of privacy principles and ethical data collection practices
|
- Understanding of privacy principles and ethical data collection practices
|
||||||
- Strong communication skills for presenting data insights to non-technical audiences
|
- Strong communication skills for presenting data insights to non-technical audiences
|
||||||
|
|
||||||
## 6. Support Team Volunteer Opportunities
|
## 6. Support Team Volunteer Opportunities
|
||||||
|
|
||||||
### 6.1 Community Support Specialists
|
### 6.1. Community Support Specialists
|
||||||
|
|
||||||
#### 6.1.1 Role Overview
|
#### 6.1.1. Role Overview
|
||||||
Community Support Specialists provide front-line assistance to community members, handling general questions and concerns while ensuring positive member experiences.
|
Community Support Specialists provide front-line assistance to community members, handling general questions and concerns while ensuring positive member experiences.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -591,17 +591,17 @@ Community Support Specialists provide front-line assistance to community members
|
|||||||
- Collaborate with other support team members to ensure consistent service quality
|
- Collaborate with other support team members to ensure consistent service quality
|
||||||
- Participate in support team training and knowledge sharing initiatives
|
- Participate in support team training and knowledge sharing initiatives
|
||||||
|
|
||||||
#### 6.1.2 Support Skills Development
|
#### 6.1.2. Support Skills Development
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Strong customer service and communication skills
|
- Strong customer service and communication skills
|
||||||
- Patience and empathy for helping community members with varying technical abilities
|
- Patience and empathy for helping community members with varying technical abilities
|
||||||
- Ability to learn and explain community systems and procedures
|
- Ability to learn and explain community systems and procedures
|
||||||
- Commitment to maintaining positive and professional interactions
|
- Commitment to maintaining positive and professional interactions
|
||||||
|
|
||||||
### 6.2 Technical Support Representatives
|
### 6.2. Technical Support Representatives
|
||||||
|
|
||||||
#### 6.2.1 Role Overview
|
#### 6.2.1. Role Overview
|
||||||
Technical Support Representatives provide specialized technical assistance to community members experiencing platform or tool issues, focusing on troubleshooting and technical guidance.
|
Technical Support Representatives provide specialised technical assistance to community members experiencing platform or tool issues, focusing on troubleshooting and technical guidance.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Provide technical assistance to community members experiencing platform or tool issues
|
- Provide technical assistance to community members experiencing platform or tool issues
|
||||||
@@ -612,58 +612,58 @@ Technical Support Representatives provide specialized technical assistance to co
|
|||||||
- Identify recurring technical problems and recommend system improvements
|
- Identify recurring technical problems and recommend system improvements
|
||||||
- Assist members with accessibility tools and assistive technology integration
|
- Assist members with accessibility tools and assistive technology integration
|
||||||
|
|
||||||
#### 6.2.2 Technical Expertise Requirements
|
#### 6.2.2. Technical Expertise Requirements
|
||||||
**Required Skills:**
|
**Required Skills:**
|
||||||
- Technical troubleshooting experience and problem-solving capabilities
|
- Technical troubleshooting experience and problem-solving capabilities
|
||||||
- Understanding of common platform and software issues
|
- Understanding of common platform and software issues
|
||||||
- Ability to explain technical concepts clearly to non-technical users
|
- Ability to explain technical concepts clearly to non-technical users
|
||||||
- Experience with documentation and guide creation
|
- Experience with documentation and guide creation
|
||||||
|
|
||||||
### 6.3 Content Support Coordinators
|
### 6.3. Content Support Coordinators
|
||||||
|
|
||||||
#### 6.3.1 Role Overview
|
#### 6.3.1. Role Overview
|
||||||
Content Support Coordinators assist community members with content creation, ensuring high-quality contributions that align with community guidelines and accessibility standards.
|
Content Support Coordinators assist community members with content creation, ensuring high-quality contributions that align with community guidelines and accessibility standards.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Assist community members with content creation, formatting, and publishing
|
- Assist community members with content creation, formatting, and publishing
|
||||||
- Provide guidance on community content guidelines and best practices
|
- Provide guidance on community content guidelines and best practices
|
||||||
- Help members optimize their contributions for accessibility and engagement
|
- Help members optimise their contributions for accessibility and engagement
|
||||||
- Coordinate with Subject Matter Experts to ensure content accuracy and quality
|
- Coordinate with Subject Matter Experts to ensure content accuracy and quality
|
||||||
- Manage content creation resources, templates, and style guides
|
- Manage content creation resources, templates, and style guides
|
||||||
- Support community content initiatives and collaborative projects
|
- Support community content initiatives and collaborative projects
|
||||||
- Monitor content quality and provide constructive feedback to contributors
|
- Monitor content quality and provide constructive feedback to contributors
|
||||||
|
|
||||||
#### 6.3.2 Content Development Skills
|
#### 6.3.2. Content Development Skills
|
||||||
**Essential Capabilities:**
|
**Essential Capabilities:**
|
||||||
- Experience with content creation, editing, or publishing
|
- Experience with content creation, editing, or publishing
|
||||||
- Understanding of accessibility principles in content development
|
- Understanding of accessibility principles in content development
|
||||||
- Strong writing and communication skills
|
- Strong writing and communication skills
|
||||||
- Ability to provide constructive feedback and guidance
|
- Ability to provide constructive feedback and guidance
|
||||||
|
|
||||||
### 6.4 Member Relations Specialists
|
### 6.4. Member Relations Specialists
|
||||||
|
|
||||||
#### 6.4.1 Role Overview
|
#### 6.4.1. Role Overview
|
||||||
Member Relations Specialists focus on fostering positive relationships within the community, supporting member integration, and facilitating communication between community members.
|
Member Relations Specialists focus on fostering positive relationships within the community, supporting member integration, and facilitating communication between community members.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
- Facilitate new member onboarding and integration into community culture
|
- Facilitate new member onboarding and integration into community culture
|
||||||
- Serve as primary point of contact for member concerns and relationship issues
|
- Serve as primary point of contact for member concerns and relationship issues
|
||||||
- Coordinate welcome programs and new member orientation activities
|
- Coordinate welcome programmes and new member orientation activities
|
||||||
- Monitor member satisfaction and engagement levels across the community
|
- Monitor member satisfaction and engagement levels across the community
|
||||||
- Mediate minor conflicts and facilitate communication between members
|
- Mediate minor conflicts and facilitate communication between members
|
||||||
- Collect member feedback and suggestions for community improvements
|
- Collect member feedback and suggestions for community improvements
|
||||||
- Maintain positive relationships and foster sense of belonging among community members
|
- Maintain positive relationships and foster sense of belonging among community members
|
||||||
|
|
||||||
#### 6.4.2 Relationship Building Skills
|
#### 6.4.2. Relationship Building Skills
|
||||||
**Required Experience:**
|
**Required Experience:**
|
||||||
- Strong interpersonal and relationship-building skills
|
- Strong interpersonal and relationship-building skills
|
||||||
- Experience with conflict mediation or resolution
|
- Experience with conflict mediation or resolution
|
||||||
- Understanding of community dynamics and member engagement principles
|
- Understanding of community dynamics and member engagement principles
|
||||||
- Excellent communication skills for facilitating discussions
|
- Excellent communication skills for facilitating discussions
|
||||||
|
|
||||||
### 6.5 Documentation Support Technicians
|
### 6.5. Documentation Support Technicians
|
||||||
|
|
||||||
#### 6.5.1 Role Overview
|
#### 6.5.1. Role Overview
|
||||||
Documentation Support Technicians maintain and improve community documentation, ensuring that all resources remain current, accurate, and accessible to community members.
|
Documentation Support Technicians maintain and improve community documentation, ensuring that all resources remain current, accurate, and accessible to community members.
|
||||||
|
|
||||||
**Key Responsibilities:**
|
**Key Responsibilities:**
|
||||||
@@ -675,7 +675,7 @@ Documentation Support Technicians maintain and improve community documentation,
|
|||||||
- Collaborate with leadership roles to document new processes and procedures
|
- Collaborate with leadership roles to document new processes and procedures
|
||||||
- Ensure documentation accessibility and usability for all community members
|
- Ensure documentation accessibility and usability for all community members
|
||||||
|
|
||||||
#### 6.5.2 Documentation Skills
|
#### 6.5.2. Documentation Skills
|
||||||
**Essential Qualifications:**
|
**Essential Qualifications:**
|
||||||
- Strong writing and editing skills with attention to detail
|
- Strong writing and editing skills with attention to detail
|
||||||
- Experience with documentation systems and content management
|
- Experience with documentation systems and content management
|
||||||
@@ -684,9 +684,9 @@ Documentation Support Technicians maintain and improve community documentation,
|
|||||||
|
|
||||||
## 7. Volunteer Selection and Application Process
|
## 7. Volunteer Selection and Application Process
|
||||||
|
|
||||||
### 7.1 Universal Selection Criteria
|
### 7.1. Universal Selection Criteria
|
||||||
|
|
||||||
#### 7.1.1 Essential Qualifications for All Volunteers
|
#### 7.1.1. Essential Qualifications for All Volunteers
|
||||||
All volunteer positions require demonstration of:
|
All volunteer positions require demonstration of:
|
||||||
|
|
||||||
**Community Participation:**
|
**Community Participation:**
|
||||||
@@ -700,9 +700,9 @@ All volunteer positions require demonstration of:
|
|||||||
- Cultural sensitivity and commitment to inclusive practices
|
- Cultural sensitivity and commitment to inclusive practices
|
||||||
- Professional maturity and emotional stability for community leadership responsibilities
|
- Professional maturity and emotional stability for community leadership responsibilities
|
||||||
|
|
||||||
#### 7.1.2 Selection Process Overview
|
#### 7.1.2. Selection Process Overview
|
||||||
**Application Submission:**
|
**Application Submission:**
|
||||||
- Complete volunteer application form: [https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8)
|
- Complete volunteer application form: [https://forms.nhcarrigan.com/form/pepb3ga79gxp8wmfef4zou96opkputjsstcaeyjhoi8](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8)
|
||||||
- Provide personal statement explaining interest and relevant experience
|
- Provide personal statement explaining interest and relevant experience
|
||||||
- Submit community references from existing members who can speak to qualifications
|
- Submit community references from existing members who can speak to qualifications
|
||||||
- Participate in interview process with existing leadership team members
|
- Participate in interview process with existing leadership team members
|
||||||
@@ -713,9 +713,9 @@ All volunteer positions require demonstration of:
|
|||||||
- Community input period allowing feedback on candidates from community members
|
- Community input period allowing feedback on candidates from community members
|
||||||
- Final selection based on established criteria and community needs assessment
|
- Final selection based on established criteria and community needs assessment
|
||||||
|
|
||||||
### 7.2 Onboarding and Integration
|
### 7.2. Onboarding and Integration
|
||||||
|
|
||||||
#### 7.2.1 New Volunteer Orientation
|
#### 7.2.1. New Volunteer Orientation
|
||||||
**Comprehensive Training Program:**
|
**Comprehensive Training Program:**
|
||||||
- Community values, mission, and strategic objectives orientation
|
- Community values, mission, and strategic objectives orientation
|
||||||
- Legal and policy framework training including all applicable policies
|
- Legal and policy framework training including all applicable policies
|
||||||
@@ -730,24 +730,24 @@ All volunteer positions require demonstration of:
|
|||||||
|
|
||||||
## 8. Volunteer Support and Recognition Systems
|
## 8. Volunteer Support and Recognition Systems
|
||||||
|
|
||||||
### 8.1 Comprehensive Support Framework
|
### 8.1. Comprehensive Support Framework
|
||||||
|
|
||||||
#### 8.1.1 Professional Development Opportunities
|
#### 8.1.1. Professional Development Opportunities
|
||||||
**Training and Skill Enhancement:**
|
**Training and Skill Enhancement:**
|
||||||
- External conference attendance and professional development support
|
- External conference attendance and professional development support
|
||||||
- Leadership coaching and mentorship programs
|
- Leadership coaching and mentorship programmes
|
||||||
- Cross-functional experience opportunities and role advancement pathways
|
- Cross-functional experience opportunities and role advancement pathways
|
||||||
- Community management best practices education and networking opportunities
|
- Community management best practices education and networking opportunities
|
||||||
|
|
||||||
**Recognition and Appreciation:**
|
**Recognition and Appreciation:**
|
||||||
- Regular volunteer appreciation events and celebration programs
|
- Regular volunteer appreciation events and celebration programmes
|
||||||
- Professional reference and recommendation support for career development
|
- Professional reference and recommendation support for career development
|
||||||
- Public recognition of outstanding volunteer contributions and service milestones
|
- Public recognition of outstanding volunteer contributions and service milestones
|
||||||
- Flexible volunteer arrangements accommodating changing life circumstances
|
- Flexible volunteer arrangements accommodating changing life circumstances
|
||||||
|
|
||||||
### 8.2 Wellness and Sustainability
|
### 8.2. Wellness and Sustainability
|
||||||
|
|
||||||
#### 8.2.1 Burnout Prevention and Volunteer Wellness
|
#### 8.2.1. Burnout Prevention and Volunteer Wellness
|
||||||
**Proactive Wellness Support:**
|
**Proactive Wellness Support:**
|
||||||
- Regular wellness check-ins and mental health resource access
|
- Regular wellness check-ins and mental health resource access
|
||||||
- Clear role boundaries and expectation management to prevent overextension
|
- Clear role boundaries and expectation management to prevent overextension
|
||||||
@@ -762,16 +762,16 @@ All volunteer positions require demonstration of:
|
|||||||
|
|
||||||
## 9. Community Impact and Volunteer Benefits
|
## 9. Community Impact and Volunteer Benefits
|
||||||
|
|
||||||
### 9.1 Community Contribution and Impact
|
### 9.1. Community Contribution and Impact
|
||||||
|
|
||||||
#### 9.1.1 Meaningful Service Opportunities
|
#### 9.1.1. Meaningful Service Opportunities
|
||||||
Volunteers contribute to creating and maintaining:
|
Volunteers contribute to creating and maintaining:
|
||||||
- Safe, welcoming, and inclusive online environments where all community members can thrive
|
- Safe, welcoming, and inclusive online environments where all community members can thrive
|
||||||
- Educational resources and programming that benefit community learning and development
|
- Educational resources and programming that benefit community learning and development
|
||||||
- Crisis response and member support systems that provide essential community safety nets
|
- Crisis response and member support systems that provide essential community safety nets
|
||||||
- Democratic governance and feedback systems that ensure community member voices are heard and valued
|
- Democratic governance and feedback systems that ensure community member voices are heard and valued
|
||||||
|
|
||||||
#### 9.1.2 Personal and Professional Benefits
|
#### 9.1.2. Personal and Professional Benefits
|
||||||
**Skill Development and Experience:**
|
**Skill Development and Experience:**
|
||||||
- Leadership and management experience applicable to professional development
|
- Leadership and management experience applicable to professional development
|
||||||
- Conflict resolution and communication skill enhancement
|
- Conflict resolution and communication skill enhancement
|
||||||
@@ -786,9 +786,9 @@ Volunteers contribute to creating and maintaining:
|
|||||||
|
|
||||||
## 10. Volunteer Policy Integration and Compliance
|
## 10. Volunteer Policy Integration and Compliance
|
||||||
|
|
||||||
### 10.1 Legal and Policy Framework
|
### 10.1. Legal and Policy Framework
|
||||||
|
|
||||||
#### 10.1.1 Comprehensive Policy Compliance
|
#### 10.1.1. Comprehensive Policy Compliance
|
||||||
All volunteers must understand and comply with:
|
All volunteers must understand and comply with:
|
||||||
|
|
||||||
**(a)** **Community Code of Conduct**: Behavioural standards and community values adherence;
|
**(a)** **Community Code of Conduct**: Behavioural standards and community values adherence;
|
||||||
@@ -801,37 +801,37 @@ All volunteers must understand and comply with:
|
|||||||
|
|
||||||
**(e)** **Recognition and Participation Policies**: Community engagement and democratic participation requirements.
|
**(e)** **Recognition and Participation Policies**: Community engagement and democratic participation requirements.
|
||||||
|
|
||||||
#### 10.1.2 Ongoing Policy Education and Updates
|
#### 10.1.2. Ongoing Policy Education and Updates
|
||||||
**Regular Policy Review:**
|
**Regular Policy Review:**
|
||||||
- Quarterly policy update training sessions for all volunteers
|
- Quarterly policy update training sessions for all volunteers
|
||||||
- New policy education and implementation training when frameworks evolve
|
- New policy education and implementation training when frameworks evolve
|
||||||
- Annual comprehensive policy compliance assessment and certification renewal
|
- Annual comprehensive policy compliance assessment and certification renewal
|
||||||
- Access to legal and policy consultation resources for complex questions and situations
|
- Access to legal and policy consultation resources for complex questions and situations
|
||||||
|
|
||||||
### 10.2 Accountability and Performance Standards
|
### 10.2. Accountability and Performance Standards
|
||||||
|
|
||||||
#### 10.2.1 Performance Evaluation and Feedback
|
#### 10.2.1. Performance Evaluation and Feedback
|
||||||
**Regular Assessment Processes:**
|
**Regular Assessment Processes:**
|
||||||
- Quarterly performance reviews incorporating community feedback and peer evaluation
|
- Quarterly performance reviews incorporating community feedback and peer evaluation
|
||||||
- Annual comprehensive assessments with goal-setting and development planning
|
- Annual comprehensive assessments with goal-setting and development planning
|
||||||
- Community feedback integration through surveys and input mechanisms
|
- Community feedback integration through surveys and input mechanisms
|
||||||
- 360-degree feedback including community members, peers, and leadership perspectives
|
- 360-degree feedback including community members, peers, and leadership perspectives
|
||||||
|
|
||||||
#### 10.2.2 Continuous Improvement and Development
|
#### 10.2.2. Continuous Improvement and Development
|
||||||
**Community-Driven Enhancement:**
|
**Community-Driven Enhancement:**
|
||||||
- Regular volunteer program assessment and improvement based on community needs
|
- Regular volunteer programme assessment and improvement based on community needs
|
||||||
- Volunteer feedback integration into program development and policy refinement
|
- Volunteer feedback integration into programme development and policy refinement
|
||||||
- Innovation in volunteer support systems and recognition programs
|
- Innovation in volunteer support systems and recognition programmes
|
||||||
- Strategic planning for volunteer program expansion and enhancement as community grows
|
- Strategic planning for volunteer programme expansion and enhancement as community grows
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Commitment to Volunteer Excellence and Community Service
|
## Commitment to Volunteer Excellence and Community Service
|
||||||
|
|
||||||
Our volunteer program represents a comprehensive framework for meaningful community service that creates lasting positive impact for both volunteers and the communities they serve. Through these opportunities, volunteers develop valuable skills, build meaningful relationships, and contribute to creating inclusive online environments where all community members can thrive.
|
Our volunteer programme represents a comprehensive framework for meaningful community service that creates lasting positive impact for both volunteers and the communities they serve. Through these opportunities, volunteers develop valuable skills, build meaningful relationships, and contribute to creating inclusive online environments where all community members can thrive.
|
||||||
|
|
||||||
We recognise that volunteer service is a gift to our community, and we are committed to providing exceptional support, training, and recognition systems that honour this contribution whilst promoting personal and professional development for all volunteers.
|
We recognise that volunteer service is a gift to our community, and we are committed to providing exceptional support, training, and recognition systems that honour this contribution whilst promoting personal and professional development for all volunteers.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This Volunteer Roles and Opportunities guide was created on 15 September 2025. For questions about volunteer opportunities or to begin the application process, please visit our application form or contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
*This Volunteer Roles and Opportunities guide provides comprehensive information about volunteer opportunities. For questions about volunteer opportunities or to begin the application process, please visit our application form or contact our Community Leaders through the designated channels outlined in our Community Code of Conduct.*
|
||||||
|
|||||||
@@ -4,25 +4,25 @@ title: Staff Application Evaluation Rubric
|
|||||||
|
|
||||||
## 1. Purpose and Scope
|
## 1. Purpose and Scope
|
||||||
|
|
||||||
This document establishes the standardized evaluation criteria for volunteer staff applications submitted to NHCarrigan. All application reviewers shall utilize this rubric to ensure consistent and objective assessment of candidates.
|
This document establishes the standardised evaluation criteria for volunteer staff applications submitted to NHCarrigan. All application reviewers shall utilise this rubric to ensure consistent and objective assessment of candidates.
|
||||||
|
|
||||||
## 2. Evaluation Methodology
|
## 2. Evaluation Methodology
|
||||||
|
|
||||||
### 2.1 Scoring System
|
### 2.1. Scoring System
|
||||||
Each evaluation criterion shall be assessed using a five-point scale:
|
Each evaluation criterion shall be assessed using a five-point scale:
|
||||||
- **Score of 5**: Exceptional performance meeting or exceeding all requirements
|
- **Score of 5**: Exceptional performance meeting or exceeding all requirements
|
||||||
- **Score of 3**: Adequate performance meeting minimum acceptable standards
|
- **Score of 3**: Adequate performance meeting minimum acceptable standards
|
||||||
- **Score of 1**: Inadequate performance failing to meet basic requirements
|
- **Score of 1**: Inadequate performance failing to meet basic requirements
|
||||||
|
|
||||||
### 2.2 Assessment Principles
|
### 2.2. Assessment Principles
|
||||||
Reviewers shall:
|
Reviewers shall:
|
||||||
1. Evaluate applications holistically while maintaining scoring consistency
|
1. Evaluate applications holistically while maintaining scoring consistency
|
||||||
2. Prioritize quality and depth of responses over length
|
2. Prioritise quality and depth of responses over length
|
||||||
3. Document specific rationale for scores assigned
|
3. Document specific rationale for scores assigned
|
||||||
|
|
||||||
## 3. Evaluation Criteria
|
## 3. Evaluation Criteria
|
||||||
|
|
||||||
### 3.1 Personal Information and Character Assessment
|
### 3.1. Personal Information and Character Assessment
|
||||||
**Objective**: Assess completeness of personal details, professional presentation, cultural alignment, and personal integrity.
|
**Objective**: Assess completeness of personal details, professional presentation, cultural alignment, and personal integrity.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
@@ -30,31 +30,31 @@ Reviewers shall:
|
|||||||
- **Adequate (3)**: Sufficient responses with limited personal insight, optional information may be omitted, basic professional presentation maintained
|
- **Adequate (3)**: Sufficient responses with limited personal insight, optional information may be omitted, basic professional presentation maintained
|
||||||
- **Inadequate (1)**: Incomplete responses, evasive answers, unprofessional presentation, or undisclosed conflicts of interest
|
- **Inadequate (1)**: Incomplete responses, evasive answers, unprofessional presentation, or undisclosed conflicts of interest
|
||||||
|
|
||||||
### 3.2 Availability and Legal Compliance
|
### 3.2. Availability and Legal Compliance
|
||||||
**Objective**: Verify time commitments, legal eligibility, and agreement to organizational requirements.
|
**Objective**: Verify time commitments, legal eligibility, and agreement to organisational requirements.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
- **Exceptional (5)**: Specific weekly time commitments provided, confirms legal volunteer status, agrees to all required documentation, demonstrates thorough understanding of organizational policies
|
- **Exceptional (5)**: Specific weekly time commitments provided, confirms legal volunteer status, agrees to all required documentation, demonstrates thorough understanding of organisational policies
|
||||||
- **Adequate (3)**: General availability indicated, acknowledges volunteer requirements, basic policy comprehension demonstrated
|
- **Adequate (3)**: General availability indicated, acknowledges volunteer requirements, basic policy comprehension demonstrated
|
||||||
- **Inadequate (1)**: Vague or unrealistic time commitments, refuses required agreements, fails to meet age/legal requirements, or demonstrates insufficient policy understanding
|
- **Inadequate (1)**: Vague or unrealistic time commitments, refuses required agreements, fails to meet age/legal requirements, or demonstrates insufficient policy understanding
|
||||||
|
|
||||||
### 3.3 Mission and Values Alignment
|
### 3.3. Mission and Values Alignment
|
||||||
**Objective**: Evaluate alignment with organizational mission, commitment to inclusivity, and accessibility awareness.
|
**Objective**: Evaluate alignment with organisational mission, commitment to inclusivity, and accessibility awareness.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
- **Exceptional (5)**: Demonstrates deep understanding of organizational mission, articulates strong commitment to inclusivity and accessibility, identifies potential challenges with proposed solutions
|
- **Exceptional (5)**: Demonstrates deep understanding of organisational mission, articulates strong commitment to inclusivity and accessibility, identifies potential challenges with proposed solutions
|
||||||
- **Adequate (3)**: Shows general mission understanding, acknowledges inclusivity and accessibility importance without detailed insight
|
- **Adequate (3)**: Shows general mission understanding, acknowledges inclusivity and accessibility importance without detailed insight
|
||||||
- **Inadequate (1)**: Limited mission comprehension, dismissive of inclusivity/accessibility requirements, or values conflicts identified
|
- **Inadequate (1)**: Limited mission comprehension, dismissive of inclusivity/accessibility requirements, or values conflicts identified
|
||||||
|
|
||||||
### 3.4 Collaboration and Accountability Standards
|
### 3.4. Collaboration and Accountability Standards
|
||||||
**Objective**: Assess teamwork capabilities, personal accountability, and feedback management skills.
|
**Objective**: Assess teamwork capabilities, personal accountability, and feedback management skills.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
- **Exceptional (5)**: Provides specific examples of successful collaboration and accountability, demonstrates balanced approach to feedback exchange, outlines clear organizational strategies
|
- **Exceptional (5)**: Provides specific examples of successful collaboration and accountability, demonstrates balanced approach to feedback exchange, outlines clear organisational strategies
|
||||||
- **Adequate (3)**: Describes teamwork experience in general terms, shows basic feedback understanding, minimal concrete examples provided
|
- **Adequate (3)**: Describes teamwork experience in general terms, shows basic feedback understanding, minimal concrete examples provided
|
||||||
- **Inadequate (1)**: Indicates collaboration difficulties, resistance to feedback, or absence of accountability mechanisms
|
- **Inadequate (1)**: Indicates collaboration difficulties, resistance to feedback, or absence of accountability mechanisms
|
||||||
|
|
||||||
### 3.5 Technical Competency Evaluation
|
### 3.5. Technical Competency Evaluation
|
||||||
**Objective**: Verify technical skills, project experience, and professional workflow capabilities.
|
**Objective**: Verify technical skills, project experience, and professional workflow capabilities.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
@@ -62,7 +62,7 @@ Reviewers shall:
|
|||||||
- **Adequate (3)**: Lists relevant technical skills with limited context, shows basic project experience, minimal detail provided
|
- **Adequate (3)**: Lists relevant technical skills with limited context, shows basic project experience, minimal detail provided
|
||||||
- **Inadequate (1)**: Insufficient technical background, lacks concrete examples, or provides unverifiable claims
|
- **Inadequate (1)**: Insufficient technical background, lacks concrete examples, or provides unverifiable claims
|
||||||
|
|
||||||
### 3.6 Leadership and Community Management
|
### 3.6. Leadership and Community Management
|
||||||
**Objective**: Assess leadership experience, conflict resolution abilities, and community development skills.
|
**Objective**: Assess leadership experience, conflict resolution abilities, and community development skills.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
@@ -70,7 +70,7 @@ Reviewers shall:
|
|||||||
- **Adequate (3)**: Shows some leadership or moderation experience with abstract examples, basic conflict resolution awareness
|
- **Adequate (3)**: Shows some leadership or moderation experience with abstract examples, basic conflict resolution awareness
|
||||||
- **Inadequate (1)**: No demonstrable leadership experience, unwillingness to develop skills, or exclusively punitive approach to violations
|
- **Inadequate (1)**: No demonstrable leadership experience, unwillingness to develop skills, or exclusively punitive approach to violations
|
||||||
|
|
||||||
### 3.7 Risk Assessment and Boundary Management
|
### 3.7. Risk Assessment and Boundary Management
|
||||||
**Objective**: Evaluate professional boundaries, crisis management capabilities, and self-awareness.
|
**Objective**: Evaluate professional boundaries, crisis management capabilities, and self-awareness.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
@@ -78,7 +78,7 @@ Reviewers shall:
|
|||||||
- **Adequate (3)**: Shows basic boundary awareness, minimal de-escalation insight, general growth acknowledgment
|
- **Adequate (3)**: Shows basic boundary awareness, minimal de-escalation insight, general growth acknowledgment
|
||||||
- **Inadequate (1)**: Fails to establish boundaries, cannot articulate risk management strategies, or shows potential bias interference
|
- **Inadequate (1)**: Fails to establish boundaries, cannot articulate risk management strategies, or shows potential bias interference
|
||||||
|
|
||||||
### 3.8 Professional Development and Resilience
|
### 3.8. Professional Development and Resilience
|
||||||
**Objective**: Assess growth mindset, stress management capabilities, and professional development goals.
|
**Objective**: Assess growth mindset, stress management capabilities, and professional development goals.
|
||||||
|
|
||||||
**Performance Standards**:
|
**Performance Standards**:
|
||||||
@@ -88,16 +88,15 @@ Reviewers shall:
|
|||||||
|
|
||||||
## 4. Final Assessment Standards
|
## 4. Final Assessment Standards
|
||||||
|
|
||||||
### 4.1 Scoring Ranges
|
### 4.1. Scoring Ranges
|
||||||
- **36-40 points**: Highly recommended candidate with exceptional organizational alignment
|
- **36-40 points**: Highly recommended candidate with exceptional organisational alignment
|
||||||
- **28-35 points**: Recommended candidate with strong potential and identified growth areas
|
- **28-35 points**: Recommended candidate with strong potential and identified growth areas
|
||||||
- **20-27 points**: Not recommended due to insufficient qualifications
|
- **20-27 points**: Not recommended due to insufficient qualifications
|
||||||
- **Below 20 points**: Rejected application
|
- **Below 20 points**: Rejected application
|
||||||
|
|
||||||
### 4.2 Documentation Requirements
|
### 4.2. Documentation Requirements
|
||||||
All reviewers shall maintain detailed scoring justification and provide specific feedback for scores below adequate performance standards.
|
All reviewers shall maintain detailed scoring justification and provide specific feedback for scores below adequate performance standards.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Effective Date**: 30 September 2025
|
**Review Schedule**: Annual or as needed based on organisational requirements
|
||||||
**Review Schedule**: Annual or as needed based on organizational requirements
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user