diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1903719..55b3873 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,10 +15,11 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu 1. Fork the repo and create a new branch from `master`. 2. If you've added code that should be tested, add tests. -3. If you've changed APIs, update the documentation. +3. Update the documentation. 4. Ensure the test suite passes. 5. Make sure your code lints. 6. Issue that pull request! +6. Clean unused files before commiting using `invoke clean` ## Any contributions you make will be under the Apache 2.0 Software License In short, when you submit code changes, your submissions are understood to be under the same [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) that covers the project. Feel free to contact the maintainers if that's a concern. @@ -41,6 +42,8 @@ People *love* thorough bug reports. I'm not even kidding. ## Use a Consistent Coding Style * 4 spaces for indentation rather than tabs +* We have many interesting commands to help create a better code, try `invoke --list` +* Use `invoke lint` and `invoke format` before commit ## License By contributing, you agree that your contributions will be licensed under its Apache License 2.0. diff --git a/pyransac3d/cylinder.py b/pyransac3d/cylinder.py index dd9bbaa..8452b0b 100644 --- a/pyransac3d/cylinder.py +++ b/pyransac3d/cylinder.py @@ -8,9 +8,9 @@ class Cylinder: """ !!! warning - The cylinder RANSAC in this library works! but does not present good results on real data on the current version. + The cylinder RANSAC does NOT present good results on real data on the current version. We are working to make a better algorithim using normals. If you want to contribute, please create a MR on github. - You'll be our hero! + Or give us ideas on [this issue](https://github.com/leomariga/pyRANSAC-3D/issues/13) Implementation for cylinder RANSAC. diff --git a/setup.py b/setup.py index a2660a0..ad56d18 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="pyransac3d", # Replace with your own username - version="0.5.0", + version="0.6.0", author="Leonardo Mariga", author_email="leomariga@gmail.com", description="A python tool for fitting primitives 3D shapes in point clouds using RANSAC algorithm ",