COMPAS v1.0 release candidate bug bash #694
Description
We are ramping up efforts to release COMPAS 1.0 very soon and we would love to squash all critical issues before doing that, for that reason, we're hosting a public bug bash this friday-monday!
What?
A bug bash is a time-bound concerted effort to find bugs and identify potential improvements in a software project. You don’t need to be a coder to take part: documentation, usability and online presence are fundamental pieces of the project that can always use improvement. The more diverse perspectives on them, the merrier.
When?
Between Friday December 11th, 09:00 until Monday December 14th, 18:00 (Central European Time)
Where?
From home, of course! Discussions/questions/etc over the forum
How?
The basic idea is that you:
- install the latest COMPAS version and/or check the documentation and
- report issues or improvements on the Github issue tracker.
How to install
-
Make sure you have Anaconda installed (with conda-forge configured. Usually everyone has it, otherwise check here)
-
Open the Anaconda prompt (or for Mac users, the terminal)
-
Type the following lines in the Anaconda prompt (optionally, choose your favorite
pythonversion):conda create -n v1-rc compas conda activate v1-rc python -m compas_rhino.install -
You are ready to start bug bashing!
What to test
Here are some ideas to test:
- Test the features you normally use with this version of COMPAS to try and identify issues
- Test basic functionality, like geometry creation, datastructures, import/export from different formats
- Test different frontends: Rhino, Grasshopper, Blender.
- Test on different IDEs: VS Code, Rhino, Rhino for Mac, Grasshopper, PyCharm, etc.
- Check that documentation matches implementation. Docs of this version are here.
- Check for gaps in documentation, especially the prose parts, examples, etc. Things that are missing altogether and would help to understand the usage and scope of the project.
How to report
Alright, you found something! What to do now?
- Open the Github Issue tracker on your browser: https://github.com/compas-dev/compas/issues/new/choose
- Check if the same thing as not been reported already (use the issue search for that)
- If not, create a new issue (select if it’s a bug report or a feature request), and follow the template instructions.
- Rinse and repeat
What’s in it for me?
Based on totally scientific criteria, we will select a winner that gets the privilege of naming the very first stable release of COMPAS. Plus a whole lot of good karma points.