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

Best practices chapter #360

Closed
c-martinez opened this issue Nov 6, 2024 · 2 comments
Closed

Best practices chapter #360

c-martinez opened this issue Nov 6, 2024 · 2 comments

Comments

@c-martinez
Copy link
Member

The guide should include a chapter on good practices, such as documentation, testing, etc. This should point to existing resources in the guide, Turing Way, RSQKit, etc.

This was referenced Nov 6, 2024
@egpbos
Copy link
Member

egpbos commented Dec 3, 2024

In #286, a lot of pages were removed that covered this type of information which is now in either the Turing Way or will be part of RSQkit. I think the topics in the removal list are a good set of topics to cover in this new chapter. Indeed, let's try as much as possible to keep this chapter short and point to existing external resources for more info. Maybe just one sentence per topic followed by an external link or two?

@egpbos
Copy link
Member

egpbos commented Dec 6, 2024

The chapter is live! It is still being worked on, but we can close this issue, I think. One final minor thing is #410, but this can be done after the v1.0 release, since it's not a user-facing change.

@egpbos egpbos closed this as completed Dec 6, 2024
@egpbos egpbos moved this to Done in Guide sprint Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants