-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add mrun.sh Script, and other docs
- Loading branch information
1 parent
b45be79
commit cf4ed77
Showing
17 changed files
with
1,124 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.{yml}] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
name: Bug Report | ||
about: Use this template to report a bug encountered in the Dojo LoM project. | ||
title: 'bug: <brief description>' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the bug, including what you were trying to accomplish when the bug occurred. | ||
|
||
## Steps to Reproduce | ||
1. Step one | ||
2. Step two | ||
3. Step three | ||
|
||
## Expected Behavior | ||
Clearly describe what you expected to happen. | ||
|
||
## Actual Behavior | ||
Describe what actually happens when the bug occurs. | ||
|
||
## Screenshots | ||
If applicable, include screenshots or error messages that help illustrate the issue. | ||
|
||
## Additional Context | ||
Add any other relevant information that might assist in diagnosing the problem, such as environment details, version numbers, and any related issues. | ||
|
||
## Checklist | ||
Before submitting your bug report, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your bug has already been reported. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Chore Request | ||
about: Use this template to propose minor tasks or maintenance work for the Dojo LoM | ||
project. | ||
title: 'chore: <brief description>' | ||
labels: chore | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the chore you are proposing. Specify the nature of the task and its relevance to the project. | ||
|
||
## Reason for Request | ||
Explain why this chore is necessary. How will it improve the project, workflow, or maintenance? | ||
|
||
## Suggested Actions | ||
Outline the specific actions you recommend for completing this chore. Include any relevant steps or considerations. | ||
|
||
## Additional Context | ||
Include any other pertinent information, such as links to related tasks, previous discussions, or project guidelines that support your request. | ||
|
||
## Checklist | ||
Before submitting your chore request, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your chore has already been reported. | ||
|
||
## Contact | ||
If you have any questions or need assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Dojo LoM Contributors Channel (Slack) | ||
url: https://app.slack.com/client/T0821V5N5F0/C0825NS0S21 | ||
about: A space for contributors to discuss development, share ideas, and collaborate on Dojo LoM projects. | ||
- name: Dojo LoM Contributors (Front-End) Channel (Slack) | ||
url: https://app.slack.com/client/T0821V5N5F0/C082B3VPB36 | ||
about: A dedicated space for front-end developers to discuss UI/UX design, front-end technologies, and collaborate on front-end development for Dojo LoM projects. | ||
- name: Dojo LoM Contributors (Back-End) Channel (Slack) | ||
url: https://app.slack.com/client/T0821V5N5F0/C082206FQMU | ||
about: A dedicated space for back-end developers to discuss server-side technologies, APIs, and collaborate on back-end development for Dojo LoM projects. | ||
- name: Dojo LoM Security Channel (Slack) | ||
url: https://app.slack.com/client/T0821V5N5F0/C0828LDJPA6 | ||
about: A space for security experts and contributors to discuss security best practices, identify vulnerabilities, and collaborate on security features for Dojo LoM projects. | ||
- name: Dojo LoM Support Channel (Slack) | ||
url: https://app.slack.com/client/T0821V5N5F0/C0825SU3B29 | ||
about: A dedicated channel for providing and receiving support regarding Dojo LoM initiatives and technical issues. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Documentation Request | ||
about: Use this template to suggest improvements or additions to the Dojo LoM documentation. | ||
title: 'documentation: <brief description>' | ||
labels: documentation | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the documentation change you are proposing. Specify which section of the documentation is affected and the nature of the changes. | ||
|
||
## Reason for Request | ||
Explain why this documentation improvement is necessary. How will it benefit users or contributors? | ||
|
||
## Suggested Changes | ||
Outline the specific changes you recommend, including any new content, modifications to existing text, or formatting adjustments. If applicable, provide examples or references to similar documentation. | ||
|
||
## Additional Context | ||
Include any other relevant information that might assist in addressing your request, such as links to external resources or related issues. | ||
|
||
## Checklist | ||
Before submitting your documentation request, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your documentation change has already been suggested. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: #contributors | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Enhancement Proposal | ||
about: Use this template to propose an enhancement or improvement for the Dojo LoM | ||
project. | ||
title: 'enhancement: <brief description>' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the enhancement you are proposing. Explain the rationale behind it and the benefits it would bring to the project. | ||
|
||
## Motivation | ||
What problem does this enhancement solve? Why is this improvement needed? | ||
|
||
## Proposed Changes | ||
Outline the specific changes or features you propose, including any relevant examples or references. | ||
|
||
## Impact | ||
Discuss how this enhancement may impact the existing codebase, user experience, or performance. | ||
|
||
## Additional Context | ||
Add any other information that may be helpful for understanding your proposal, such as related issues, use cases, or potential challenges. | ||
|
||
## Checklist | ||
Before submitting your enhancement proposal, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your enhancement has already been suggested. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Feature Request | ||
about: Use this template to propose a new feature or functionality for the Dojo LoM | ||
project. | ||
title: 'feat: <brief description>' | ||
labels: feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the feature you are requesting. Explain its purpose and how it will benefit the project or its users. | ||
|
||
## Use Cases | ||
Describe the specific scenarios in which this feature will be utilized. How will it improve user experience or workflow? | ||
|
||
## Proposed Implementation | ||
Outline how you envision this feature being implemented. Include any relevant examples or references that may assist in understanding your proposal. | ||
|
||
## Potential Challenges | ||
Identify any potential challenges or obstacles that may arise during the implementation of this feature. | ||
|
||
## Additional Context | ||
Add any other relevant information that may help in evaluating your request, such as related issues, prior discussions, or dependencies. | ||
|
||
## Checklist | ||
Before submitting your feature request, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your feature has already been requested. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: General Task | ||
about: Use this template to outline a task that needs to be completed within the Dojo LoM | ||
project. This can include non-issue related tasks, refactoring, updates, or any | ||
other type of work. | ||
title: 'general: <brief description of the task>' | ||
labels: general | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the task. Explain its purpose, importance, and any relevant context. | ||
|
||
## Acceptance Criteria | ||
List the criteria that need to be met for the task to be considered complete. | ||
|
||
## Dependencies | ||
If this task depends on any other tasks or issues, please specify them here. | ||
|
||
## Additional Context | ||
Add any additional context or information that may help in completing the task. | ||
|
||
## Checklist | ||
Before submitting your task, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
|
||
## Contact | ||
If you have any questions or need assistance, feel free to reach out via: | ||
- Slack Channel: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- Email: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
name: Performance Issue | ||
about: Use this template to report a performance-related issue in the Dojo LoM project. | ||
title: 'performance: <brief description>' | ||
labels: performance | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the performance issue, including what you were trying to accomplish when the issue occurred. | ||
|
||
## Steps to Reproduce | ||
1. Step one | ||
2. Step two | ||
3. Step three | ||
|
||
## Expected Behavior | ||
Clearly describe what you expected to happen in terms of performance. | ||
|
||
## Actual Behavior | ||
Describe what actually happens, including any metrics or indicators of poor performance (e.g., slow load times, high latency). | ||
|
||
## Screenshots | ||
If applicable, include screenshots or error messages that help illustrate the performance issue. | ||
|
||
## Additional Context | ||
Add any other relevant information that might assist in diagnosing the problem, such as environment details, version numbers, system configurations, and any related issues. | ||
|
||
## Checklist | ||
Before submitting your performance issue report, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your performance issue has already been reported. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Question Submission | ||
about: Use this template to ask questions or seek clarification about the Dojo LoM | ||
project. | ||
title: 'question: <brief description>' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Question | ||
Please provide a clear and concise description of your question. Specify the context or area of the project your inquiry relates to. | ||
|
||
## Additional Context | ||
Include any relevant information that may help in answering your question, such as: | ||
- Previous discussions or documentation references. | ||
- Any attempts you have made to resolve your question. | ||
|
||
## Checklist | ||
Before submitting your question, please ensure you have: | ||
- [ ] Reviewed the [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. | ||
- [ ] Checked the [LICENSE.md](../../LICENSE.md) for compliance. | ||
- [ ] Consulted the [SECURITY.md](../../SECURITY.md) for security practices. | ||
- [ ] Searched the existing issues to see if your question has already been asked. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please reach out via: | ||
- **Slack Channel**: [#contributors](https://app.slack.com/client/T0821V5N5F0/C0825NS0S21) | ||
- **Email**: [[email protected]](mailto:[email protected]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
name: Security Vulnerability Report | ||
about: Use this template to report a security vulnerability within the Dojo LoM project. | ||
Responsible disclosure is critical for maintaining the security and integrity of | ||
our codebase. | ||
title: 'security: <brief description of the vulnerability>' | ||
labels: security | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Description | ||
Provide a detailed description of the security vulnerability, including its potential impact and severity. | ||
|
||
## Steps to Reproduce | ||
1. Step one to reproduce the vulnerability. | ||
2. Step two. | ||
3. Step three. | ||
|
||
## Expected Behavior | ||
Describe what should happen without the vulnerability. | ||
|
||
## Actual Behavior | ||
Describe what happens due to the vulnerability. | ||
|
||
## Additional Context | ||
Include any additional information that may be relevant, such as configurations, versions affected, or related vulnerabilities. | ||
|
||
## Affected Versions | ||
Specify the versions of the software affected by this vulnerability. | ||
|
||
## Suggested Mitigation | ||
If applicable, provide any suggestions for mitigating the vulnerability. | ||
|
||
## Checklist | ||
Before submitting your vulnerability report, please ensure you have: | ||
- [ ] Reported the vulnerability directly to **[email protected]**. | ||
- [ ] Reviewed the [SECURITY.md](../../SECURITY.md) for reporting procedures. | ||
- [ ] Consulted the [CONTRIBUTING.md](../../CONTRIBUTING.md) for additional guidelines. | ||
|
||
## Contact | ||
If you have any questions or need assistance, feel free to reach out via: | ||
- Slack Channel: [#security](https://app.slack.com/client/T0821V5N5F0/C0828LDJPA6) | ||
- Email: [[email protected]]([email protected]) |
Oops, something went wrong.