Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
59 changes: 59 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Pull Request
about: Submit changes to the project for review and inclusion
---

## Description

<!--- Describe the changes introduced by this pull request. -->
<!--- Explain what problem it solves or what feature/fix it adds. -->

## Related Issue

<!--- If this pull request is related to a specific issue, reference it here using #issue_number. -->
<!--- For example, "Fixes #123" or "Addresses #456". -->

This PR fixes #

## Changes Made

<!--- Provide a summary of the changes made in this pull request. -->
<!--- Include any relevant technical details or architecture changes. -->

- Change 1
- Change 2
- ...

## Testing Performed

<!--- Describe the testing that you have performed to validate these changes. -->
<!--- Include information about test cases, testing environments, and results. -->

- Tested feature X in scenario Y.
- Ran unit tests for component Z.
- Tested on browsers A, B, and C.
- ...

## Checklist

<!--- Please check the boxes that apply to this pull request. -->
<!--- You can add or remove items as needed. -->

- [ ] I have tested these changes locally and they work as expected.
- [ ] I have added/updated tests that prove the effectiveness of these changes.
- [ ] I have updated the documentation to reflect these changes, if applicable.
- [ ] I have followed the project's coding style guidelines.
- [ ] I have addressed the code review feedback from the previous submission, if applicable.

## Additional Notes for Reviewers

<!--- Provide any additional context or notes for the reviewers. -->
<!--- This might include details about design decisions, potential concerns, or anything else relevant. -->

---

Thank you for contributing to our project! We appreciate your help in improving it.

📚 See [contributing instructions](https://github.com/sugarlabs/musicblocks/blob/master/README.md).

🙋🏾🙋🏼 Questions: [Community Matrix Server](https://matrix.to/#/#sugar:matrix.org).
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@

# [Sugar Labs](https://www.sugarlabs.org/)

# Sugar Labs web site
## Sugar Labs Web Site

</div>

## Aims

* To announce our vision and mission,
* To invite potential users of Sugar Labs software,
* To advertise our free software and licensing approach,
* To provide links to software downloads, and;
* To invite potential developers to the source code we hold in trust.
- Announce our vision and mission.
- Invite potential users of Sugar Labs software.
- Advertise our free software and licensing approach.
- Provide links to software downloads.
- Invite potential developers to the source code we hold in trust.

## Contributing

Content on the site, that is information about Sugar, Sugarizer, or Music Blocks, is _way more important_ than the style or appearance.
Content about Sugar, Sugarizer, or Music Blocks is **far more important** than the site's style or appearance.

Please concentrate on updating the content of the site, and not the style or appearance.
Please prioritize updating the site's content over its design.

For your pull requests or issues to be taken seriously, you must be a user or developer of one of our software products; Sugar, Sugarizer, or Music Blocks.
To have your pull requests or issues considered seriously, you must be a user or developer of one of our software products: **Sugar, Sugarizer, or Music Blocks**.

For detailed information refer to the [Contribution's Guide](docs/CONTRIBUTING.md).
For detailed guidelines, refer to the [Contribution Guide](docs/CONTRIBUTING.md).

## Tech Stack

SugarWeb is a client-side web application written in TypeScript. React is used to render UI components, and the project is set up to independently use any JavaScript UI library/framework or the JS DOM API directly. It is bundled using Vite.
SugarWeb is a client-side web application written in TypeScript. It utilizes React for UI components and is designed to work with any JavaScript UI library/framework or the JS DOM API directly. The project is bundled using Vite.

### Application

* TypeScript 5
* React 19
* Tailwind CSS
- TypeScript 5
- React 19
- Tailwind CSS

### Tooling

* Node.js
* Vite
* ESLint
* Prettier
- Node.js
- Vite
- ESLint
- Prettier

## Development

To get started with development refer to the [Developer Guide](docs/dev_guide.md).
To get started with development, refer to the [Developer Guide](docs/dev_guide.md).
21 changes: 21 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "new-york",
"rsc": false,
"tsx": true,
"tailwind": {
"config": "",
"css": "src/styles/globals.css",
"baseColor": "zinc",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"iconLibrary": "lucide"
}
5 changes: 2 additions & 3 deletions docs/Adding_favicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@

If you need to update the colors of an existing favicon, edit the SVG file and update the hex codes in the following places:

- `flood-color="#00FFFF"`
- `fill="#40C0E7"`
- `stroke="#00FFFF"`
- `fill="#033CD2"`
- `stroke="#FF7800"`

Ensure that the new colors remain consistent with the current favicon theme.
46 changes: 46 additions & 0 deletions docs/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Security Policy

## Reporting a Vulnerability

If you discover a security vulnerability within this project, please follow the steps below to responsibly disclose it:

1. **Do not open an issue or pull request directly on GitHub**. This avoids making the vulnerability public and potentially exploitable by malicious actors.
2. **Send an email to our security team** at [[email protected]](mailto:[email protected]) with the following details:
- A description of the vulnerability and its impact.
- Detailed steps to reproduce the vulnerability, including any relevant code snippets, configuration details, or screenshots.
- Any potential mitigations or fixes you have identified.

Our security team will acknowledge receipt of your report within 48 hours and will work with you to understand and address the issue. We aim to resolve critical vulnerabilities as quickly as possible and will provide updates on the status of the fix.

## Supported Versions

We only support the latest version of the project for security updates. Please ensure you are using the most recent release to benefit from the latest security enhancements.

| Version | Supported |
| ------- | ------------------ |
| Latest | :white_check_mark: |

## Security Best Practices

To help ensure the security of your contributions and the overall project, please follow these best practices:

1. **Stay Informed**: Keep up-to-date with the latest security advisories and updates related to the technologies used in this project, such as TypeScript, React, Node.js, and npm.
2. **Use Strong Authentication**: Enable two-factor authentication (2FA) on your GitHub account to protect your contributions and maintain the integrity of the project.
3. **Review Dependencies**: Regularly review and update project dependencies to ensure they are free from known vulnerabilities. Use tools like `npm audit` to identify and address security issues in dependencies.
4. **Follow Secure Coding Guidelines**: Adhere to secure coding practices, such as validating input, sanitizing output, and avoiding the use of unsafe functions. Refer to resources like the [OWASP Top Ten](https://owasp.org/www-project-top-ten/) for guidance.
5. **Report Suspicious Activity**: If you notice any suspicious activity or potential security issues within the project or its dependencies, report it immediately to the security team.

## Handling Sensitive Information

Avoid including sensitive information, such as passwords, API keys, or personal data, in your code contributions or public discussions. If sensitive information is accidentally exposed, notify the security team immediately to mitigate any potential impact.

## Code Quality and Security

To maintain a high level of security and code quality, please adhere to the following guidelines when contributing to the project:

1. **Conduct Code Reviews**: All pull requests must be reviewed by at least one other contributor before being merged. Reviewers should pay close attention to potential security issues and ensure that the code follows best practices.
2. **Write Unit Tests**: Include unit tests for any new functionality or changes to existing code to ensure that the code behaves as expected and does not introduce security vulnerabilities.
3. **Use Linting Tools**: Run linting tools, such as ESLint, to identify and address potential security issues and code quality problems.
4. **Continuous Integration**: Ensure that all tests pass and that the code meets the project's quality standards before merging pull requests. Use continuous integration tools, such as GitHub Actions, to automate these checks.

Thank you for helping us maintain the security and integrity of our project!
Loading