diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7313cfa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## Changes + +## Reasoning + + + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9390e07 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,31 @@ +# Code of Conduct + +## Our Commitment +We are committed to fostering an open and welcoming environment for all contributors. We pledge to make participation in our project 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. + +## Expected Behavior +- Be respectful and inclusive. +- Communicate openly and professionally. +- Give constructive feedback and be receptive to feedback from others. +- Respect differing viewpoints and experiences. +- Be supportive and help others when possible. + +## Unacceptable Behavior +- Harassment, discrimination, or exclusionary behavior of any kind. +- Personal attacks, insults, or derogatory comments. +- The use of inappropriate language or imagery. +- Trolling, spamming, or other disruptive behavior. +- Any conduct that is harmful or makes others feel unsafe. + +## Reporting Issues +If you experience or witness unacceptable behavior, please report it to the project maintainers email [@luca-c-xcv] [@feed3r] . All reports will be reviewed and addressed confidentially. + +## Enforcement +Project maintainers have the right to remove, edit, or reject contributions that violate this Code of Conduct. Violators may be warned, temporarily banned, or permanently removed from the project at the discretion of the maintainers. + +## Acknowledgment +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1. + +--- +By participating in this project, you agree to abide by this Code of Conduct. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..082366f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contribuiting to RustShare + +Thank you for considering contributing to this project! We appreciate your time and effort in helping improve this software. Please follow the guidelines below to ensure a smooth collaboration. + +## Getting Started + +1. **Fork the Repository**: Click the "Fork" button on GitHub and clone your fork. +2. **Create a Branch**: Use a descriptive name for your branch (e.g., `feature/add-logging` or `bugfix/fix-crash`). +3. **Set Up the Environment**: Follow the installation and setup instructions in the README. + +## How to Contribute + +### Bug Reports +- Ensure the issue has not already been reported in the [Issues](https://github.com/ALRusting/RustShare/issues) tab. +- Provide a clear and descriptive title. +- Include steps to reproduce, expected behavior, and actual behavior. +- Attach logs, screenshots, or any relevant details. + +### Feature Requests +- Open an issue describing the feature and its benefits. +- Discuss implementation details before starting work. + +### Code Contributions +- Follow the existing coding style and conventions. +- Write meaningful commit messages. +- Ensure your code is well-documented. +- Add tests if applicable. +- Run existing tests to ensure nothing is broken. + +### Pull Requests +1. Ensure your code follows the project’s style guide. +2. Include a clear description of the changes. +3. Reference related issues if applicable. +4. Submit your pull request and request a review from the maintainers. + +## Code of Conduct +By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful and inclusive in all interactions. + +## Contact +If you have any questions, feel free to open an issue or reach out to the maintainers. + +Happy Coding! diff --git a/README.md b/README.md index ae015aa..33d350a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ -# RustShare -A system to share files between devices in the same network +
+ +

RustShare

+

+ A system to share files between devices in the same network +
+

+
diff --git a/assets/logo.jpg b/assets/logo.jpg new file mode 100644 index 0000000..20e60e1 Binary files /dev/null and b/assets/logo.jpg differ