Home

Welcome to the birdseye wiki! This is to help developers contribute. Here's how you can get started if you want to help:

1. Fork the repository, and clone your fork.
2. Install birdseye from the root of the repo you just cloned. If you have one or more other projects that you're working on where birdseye might be useful for development and debugging, install birdseye into the interpreter (so the virtualenv if there is one) used for that project.
3. Try using birdseye for a bit, ideally in a real debugging scenario. Get a feel for what using it is like. Note any bugs it has or features you'd like added. Create an issue where appropriate or ask questions on the gitter chatroom.
4. Pick an issue that interests you and that you'd like to work on, either one that you created or an existing one. An issue with the easy label might be a good place to start.
5. Read through the source code overview to get an idea of how it all works.
6. Run the tests before making any changes just to verify that it all works on your computer.
7. Dive in and start coding! I've tried to make the code readable and well documented. Don't hesitate to ask any questions on gitter. If you installed correctly, you should find that changes you make to the code are reflected immediately when you run it.
8. Once you're happy with your changes, make a pull request.