Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: need to add a section on common debugging practices for Akka.NET (contributors) #5467

Closed
Tracked by #5461
Aaronontheweb opened this issue Dec 29, 2021 · 0 comments
Labels

Comments

@Aaronontheweb
Copy link
Member

Please describe what you are trying to understand
I want to add a section to our documentation that explains, for developers working on contributing to Akka.NET itself, some of the common development and debugging practices designed to help make things easier.

How can we do it better?
For instance, I think it would be great if we added some advice on how to:

  1. Debug racy unit tests;
  2. Best practices to testing configuration changes;
  3. Benchmarking Akka.NET;
  4. Memory profiling Akka.NET;
  5. Debugging a multi-node test;
  6. Creating effective reproduction scenarios; and
  7. Where various classes of network errors likely originate.

Some of those material might be equally valuable to users as well and I think we might want to consider adding a separate section that is entirely user-facing, for dealing with Akka.NET application design debugging issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant