diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8a48503 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,29 @@ +# Code of Conduct + +Parallel is built on respect—for users, contributors, and the systems we design. We expect all participants to uphold a collaborative, inclusive, and transparent environment. + +## 🌱 Our Pledge + +In the interest of fostering an open and welcoming community, we pledge to: + +- Respect differing viewpoints and experiences. +- Offer constructive feedback and thoughtful critique. +- Avoid personal attacks, trolling, or disruptive behavior. +- Honor the modular, expressive spirit of the project. + +## 🚫 Unacceptable Behavior + +Examples include: + +- Harassment or discrimination of any kind. +- Dismissive or hostile responses to questions or feedback. +- Sharing private information without consent. +- Sabotaging or intentionally breaking the project. + +## 🧭 Enforcement + +Violations may result in warnings, temporary bans, or permanent removal from the project. Enforcement decisions are made by project maintainers. + +## 🙌 Scope + +This Code of Conduct applies to all project spaces—GitHub issues, pull requests, discussions, and any other community interactions. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..953f2c1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to Parallel + +Thanks for your interest in contributing to Parallel! This project is built on transparency, modularity, and control. Whether you're fixing a bug, proposing a feature, or refining architecture, your input helps shape a tool that puts users in better control of their files. + +## 🛠 Development Philosophy + +Parallel is: +- **Modular**: Each component should be independently testable and replaceable. +- **Audit-friendly**: Changes should be traceable, documented, and intentional. +- **Local-first**: Avoid assumptions about cloud dependencies. +- **Legacy-worthy**: Code should be expressive, maintainable, and built to last. + +## 🧱 Getting Started + +1. **Clone the repo**: + `git clone https://github.com/TheGuitarleader/Parallel.git` +2. Create a new branch: + `git checkout -b feature/your-feature-name` + `git checkout -b patch/your-patch-name` +3. Make your changes with clear, modular commits. +4. Push and open a **Pull Request** (PR): + `git push origin feature/your-feature-name` + `git push origin patch/your-patch-name` + +## 🔍 Pull Request Guidelines + +- Use descriptive titles and commit messages. +- Reference related issues (e.g. `Fixed #42`). +- Include tests for new logic where applicable. +- Keep PRs focused—one feature or fix per PR. +- Be open to feedback and iteration. + +## 🧪 Testing Expectations + +Parallel uses modular test suites. Before submitting a PR: +- Run all relevant tests. +- Add new ones if your logic introduces new behavior. +- Validate edge cases and failure modes. + +## 🧭 Branch Protection & CI/CD + +All changes go through PR review. CI/CD pipelines validate builds across platforms. Please ensure your changes pass all checks before requesting review. + +## 💬 Communication + +Use [GitHub Issues](https://github.com/TheGuitarleader/Parallel/issues) for bugs, ideas, and discussion. We welcome thoughtful dialogue and collaborative troubleshooting. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index b75b631..2f1c6e7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,2 +1,7 @@ -Parallel © 2025 by [Kyle Ebbinga](https://github.com/TheGuitarleader/Parallel) is licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/) +Parallel is licensed under the [**Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)**](https://creativecommons.org/licenses/by-nc-sa/4.0/) license. +* ✅ You can **use, modify, and share** this code freely. +* ✅ You can **build on it**, fork it, and remix it — as long as you credit the original. +* ❌ You **cannot sell** this code or use it in commercial products. +* ❌ You **cannot claim it as your own** or strip attribution. +* 🔁 If you make changes and share them, you must use the same license \ No newline at end of file diff --git a/README.md b/README.md index 6da2a97..e709fc4 100644 --- a/README.md +++ b/README.md @@ -37,21 +37,6 @@ Your computer already gives you enough to fight with — your files don't have t Parallel is currently in early development. Expect rapid iteration, breaking changes, and lots of modular experimentation. Contributions, feedback, and testing are welcome! -## 🤝 Contributing - -Want to help shape the future of file storage? Open an issue, submit a pull request, or reach out with ideas. Parallel is built for transparency — and that includes its development. - -## 📄 License - -Parallel is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)** license. - -* ✅ You can **use, modify, and share** this code freely. -* ✅ You can **build on it**, fork it, and remix it — as long as you credit the original. -* ❌ You **cannot sell** this code or use it in commercial products. -* ❌ You **cannot claim it as your own** or strip attribution. -* 🔁 If you make changes and share them, you must use the same license - ## 💬 Contact For questions and ideas, reach out via our [GitHub Issues](https://github.com/TheGuitarleader/Parallel/issues). -