adding license, code of conduct, templates... etc)

This commit is contained in:
DioCrafts
2025-03-26 10:40:57 +01:00
parent bd623ec07e
commit 8b1f6d71c8
11 changed files with 336 additions and 8 deletions

43
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,43 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---
## Description
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.
## Environment
- OS: [e.g. Ubuntu 22.04, Windows 11]
- Browser: [e.g. Chrome 120, Firefox 121]
- OxiCloud Version: [e.g. 0.1.0]
- Rust Version: [e.g. 1.70.0]
## Additional Context
Add any other context about the problem here.
## Possible Solution
If you have ideas on how to fix the issue, please describe them here.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: OxiCloud Documentation
url: https://github.com/DioCrafts/oxicloud/wiki
about: Please check the documentation before opening an issue

View File

@@ -0,0 +1,24 @@
---
name: Documentation request
about: Request improvements or additions to documentation
title: '[DOCS] '
labels: documentation
assignees: ''
---
## What documentation needs to be improved or added?
Clearly describe which part of the documentation needs to be improved or what new documentation is needed.
## Why is this documentation important?
Explain why this documentation would be valuable to users or contributors.
## Suggested content
If you have ideas about what should be included in this documentation, please share them here.
## Additional context
Add any other context, examples from other projects, or screenshots about the documentation request here.

View File

@@ -0,0 +1,32 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---
## Problem Statement
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Proposed Solution
A clear and concise description of what you want to happen.
## Alternative Solutions
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.
## User Impact
Describe how this feature would benefit users of OxiCloud.
## Implementation Ideas
If you have ideas about how this might be implemented, please share them here.

34
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,34 @@
## Description
<!-- Please include a summary of the changes and the related issue (if applicable). Please also include relevant motivation and context. -->
## Related Issue
<!-- Please link to the issue here if applicable. -->
## Type of Change
Please check the option that best describes your change:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Documentation update
## How Has This Been Tested?
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. -->
## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

13
CODEOWNERS Normal file
View File

@@ -0,0 +1,13 @@
# These owners will be the default owners for everything in the repo.
# Unless a later match takes precedence, they will be requested for
# review when someone opens a pull request.
* @DioCrafts
# Specific file and directory ownership
/src/domain/ @DioCrafts
/src/application/ @DioCrafts
/src/infrastructure/ @DioCrafts
/src/interfaces/ @DioCrafts
/static/ @DioCrafts
/db/ @DioCrafts
*.md @DioCrafts

43
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,43 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)

73
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,73 @@
# Contributing to OxiCloud
Thank you for your interest in contributing to OxiCloud! This document provides guidelines and instructions for contributing to the project.
## Code of Conduct
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone. Please be considerate of other contributors and users.
## How to Contribute
There are many ways to contribute to OxiCloud:
1. Reporting bugs
2. Suggesting enhancements
3. Writing documentation
4. Improving code
5. Adding translations
### Reporting Bugs
If you find a bug, please create an issue with the following information:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots if applicable
- System information (OS, browser, etc.)
### Suggesting Enhancements
Enhancement suggestions are welcome! Please include:
- A clear and detailed explanation of the feature
- Why this feature would be useful to most OxiCloud users
- Possible implementation approaches if you have ideas
### Pull Request Process
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/something-useful`)
3. Make your changes
4. Run the tests and linters to ensure your code meets our quality standards:
```bash
cargo test
cargo clippy
cargo fmt --check
```
5. Commit your changes with a descriptive message
6. Push to your branch
7. Create a Pull Request to the `dev` branch
### Development Guidelines
Please follow the development guidelines in the [CLAUDE.md](CLAUDE.md) file, which include:
- Code style guidelines
- Architecture principles
- Testing requirements
- Documentation standards
## Development Environment Setup
Follow the setup instructions in the [README.md](README.md) to set up your development environment.
## Getting Help
If you need help with the contribution process or have questions, feel free to:
- Open an issue with your question
- Reach out to the maintainers
Thank you for contributing to OxiCloud!

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 OxiCloud Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1,4 +1,4 @@
# 🚀 OxiCloud
# 🚀 OxiCloud [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
<p align="center">
<img src="static/oxicloud-logo.svg" alt="OxiCloud" width="300" />
@@ -95,17 +95,13 @@ See [TODO-LIST.md](TODO-LIST.md) for my current development priorities.
## 🤝 Contributing
Contributions are welcome! The project is still in early stages, so there's lots of room for improvement:
Contributions are welcome! The project is still in early stages, so there's lots of room for improvement.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/something-useful`)
3. Commit your changes (`git commit -m 'Add something useful'`)
4. Push to the branch (`git push origin feature/something-useful`)
5. Open a Pull Request
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed information on how to contribute to OxiCloud. All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
## 📜 License
OxiCloud is available under the MIT License. See the LICENSE file for more information.
OxiCloud is available under the [MIT License](LICENSE). See the [LICENSE](LICENSE) file for more information.
---

44
SECURITY.md Normal file
View File

@@ -0,0 +1,44 @@
# Security Policy
## Supported Versions
The following versions of OxiCloud are currently supported with security updates:
| Version | Supported |
| ------- | ------------------ |
| Latest | :white_check_mark: |
## Reporting a Vulnerability
The OxiCloud team takes security issues seriously. We appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions.
To report a security vulnerability, please follow these steps:
1. **DO NOT** disclose the vulnerability publicly (e.g., in GitHub issues)
2. Email details of the vulnerability to the project maintainers
3. Include as much information as possible, such as:
- A clear description of the vulnerability
- Steps to reproduce the issue
- Potential impact
- Suggested fixes if available
## What to Expect
After submitting a vulnerability report, you can expect the following:
1. **Acknowledgment**: The team will acknowledge receipt of your report within 3 business days
2. **Assessment**: We'll evaluate the vulnerability and determine its impact
3. **Plan**: We'll develop a plan to address the vulnerability
4. **Fix & Release**: Once fixed, we'll release an update
5. **Recognition**: With your permission, we'll acknowledge your contribution in the release notes
## Security Best Practices for OxiCloud Users
- Keep your OxiCloud installation updated to the latest version
- Use strong, unique passwords for all user accounts
- Configure proper file permissions
- Regularly back up your data
- Consider running OxiCloud behind a reverse proxy with HTTPS
- Implement IP restrictions where appropriate
Thank you for helping keep OxiCloud and its users secure!