summaryrefslogtreecommitdiff
path: root/CONTRIB.md
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 02:54:59 +0000
committerRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 02:54:59 +0000
commita2df70609a4711b4eb673f28cee3e6f72414148a (patch)
tree972f05e70f17ddbe0337c4e2cc48797475131413 /CONTRIB.md
parentbf4e309a698592cdb815580f97db97b268fd6668 (diff)
downloadpyvyos-a2df70609a4711b4eb673f28cee3e6f72414148a.tar.gz
pyvyos-a2df70609a4711b4eb673f28cee3e6f72414148a.zip
chore: trim root, move examples, drop committed uv.lock
- delete CONTRIB.md (superseded by CONTRIBUTING.md) - delete requirements.txt (duplicated [project].dependencies) - delete test_quick.py (ad-hoc smoke covered by tests/test_shims.py) - rewrite example.py as examples/basic.py using the public API (from pyvyos import VyDevice) and drop the RuntimeWarning suppression - move vagrant/ to examples/vagrant/ - stop tracking uv.lock and add it to .gitignore (library, not app) - README: link the examples/ directory - CHANGELOG: document the moves and removals
Diffstat (limited to 'CONTRIB.md')
-rw-r--r--CONTRIB.md79
1 files changed, 0 insertions, 79 deletions
diff --git a/CONTRIB.md b/CONTRIB.md
deleted file mode 100644
index 3ff741d..0000000
--- a/CONTRIB.md
+++ /dev/null
@@ -1,79 +0,0 @@
-# Contributing to pyvyos
-
-We welcome contributions to the pyvyos project! If you're looking to contribute, please take a moment to read this guide to understand how you can be a part of our community and help make pyvyos better.
-
-## Code of Conduct
-
-We expect all contributors to adhere to our Code of Conduct. Respectful, collaborative behavior is crucial to maintaining a healthy environment.
-
-## How to Contribute
-
-There are many ways to contribute to pyvyos:
-
-- **Submitting bug reports and feature requests:** Use our issue tracker to report bugs or suggest features.
-- **Writing code:** Feel free to take on open issues or propose new changes. Please follow the guidelines outlined below.
-- **Improving documentation:** Good documentation is crucial. Contributions to improve or clarify documentation are always appreciated.
-
-## Development Process
-
-1. **Fork and Clone the Repository**
- - Start by forking the repository and then cloning it to your local machine.
-
-2. **Set Up Your Environment**
- - We recommend using [uv](https://docs.astral.sh/uv/) for dependency management. Ensure you have Uv installed and then run `uv pip install -e .[dev]` to set up your environment.
-
-3. **Create a Feature Branch**
- - Create a branch for your feature or bugfix, e.g., `git checkout -b feature/add-new-command`.
-
-4. **Write Your Code**
- - Write your code following Python best practices and adhering to PEP 8.
- - Include comments where necessary to explain complex parts of your code.
-
-5. **Write Tests**
- - We use PyTest for testing. Please add tests for your code and ensure all tests pass.
-
-6. **Document Your Changes**
- - Update the README.md or documentation if your changes require it.
-
-7. **Commit Your Changes**
- - Use clear and descriptive commit messages.
- - Make sure to commit your changes regularly.
-
-8. **Push to Your Fork and Submit a Pull Request**
- - Push your changes to your fork and then submit a pull request to our repository.
- - In your pull request, clearly describe the changes and their purpose.
-
-## Code Review Process
-
-- After you submit a pull request, the project maintainers will review your code.
-- Be open to feedback and willing to make changes to your code.
-- Once your pull request is approved, a maintainer will merge it.
-
-## Reporting Bugs
-
-- Use GitHub Issues to report bugs.
-- Be as detailed as possible in your bug report. Include steps to reproduce the bug and any relevant logs or screenshots.
-
-## Suggesting Enhancements
-
-- Use GitHub Issues to suggest enhancements.
-- Clearly explain the suggested feature and its benefits.
-
-## License
-
-By contributing to pyvyos, you agree that your contributions will be licensed under the same license that covers the project.
-
-Thank you for considering contributing to pyvyos. Your efforts are what make this project great!
-
-## Unit Tests
-Ensure you've installed development dependencies first:
-```bash
- uv pip install -e .[dev]
-```
-
-To view test coverage:
-```bash
- pytest -v --cov
-```
-
-**Note:** Tests should run against a development environment or mocked device to prevent production changes.