If you encounter any problem while working with scotty feel free to open a new issue. Ensure that the issue includes
- ..the effected version (
scotty version) - ..a step by step guide of to reproduce the issue alongside context about the kind of logs streamed
Something is missing for in scotty? Make a proposal of your idea by creating an issue.
Try to explain why you think this feature could be useful also to others by solving which problem?
note: the code contribution guidelines also apply the beam repository. however please refer to issues and contributions within its repository
Developing with go-1.18 for potential usage of generics.
Within the scotty repository there is a /test directory with a dummy application producting structured logs. This can be used for testing. With the flag -delay one can increase the random time-out between each logs which can be useful to either stress test a feature or slow down for debugging.
Please also have a look at the UI library used in the project which is bubbletea. Bubbletea is a great and extensible framework build on the concept of the Elm Architecture - it's also worth browsing through their docs for a better understanding of how bubbletea works internally :).
- Start a dialog on a ticket you want to solve, and discuss any open questions closing with a statement to work on the issue
- Fork the repository & clone the repository
- verify all works with
go run -race main.go version
- Committed code should follow the Effective Go guidelines.
- Code should be formatted with
gofmt -sand checked withgo vet. - Types and functions exported by a package should have a comment stating what they are doing.
- implement all required changes to solve the ticket and write tests if applicable and useful.
- Test your changes locally and ensure all other tests continue to pass using
go test -v ./.... - Commit your changes to your forked repository and open a PR with a reference to the issue/ticket.