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.

Sign up for GitHub

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

Jump to bottom

Documenting best practices of knuu for test development #3601

Closed
staheri14 opened this issue Jun 19, 2024 · 2 comments
Closed

Documenting best practices of knuu for test development #3601

staheri14 opened this issue Jun 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation needs:grooming items needs a status change, to be closed, or clearer AC. Item should be discussed next sync.

Comments

@staheri14
Copy link
Collaborator 

          what's the best way to keep track of important details such as this @smuu? we could add a code comment above, but I imagine this would also be important to know when creating tests for node as well

Originally posted by @evan-forbes in #3515 (comment)
@staheri14 staheri14 changed the title documenting best practices of knuu for test development Documenting best practices of knuu for test development Jun 19, 2024
@staheri14 staheri14 mentioned this issue Jun 19, 2024
Merged
@evan-forbes evan-forbes added the documentation Improvements or additions to documentation label Jul 1, 2024
@evan-forbes
Copy link
Member

I think in this particular case, we should just require that we add appropriate documentation either before merging or write an issue that describes which documentation needs to be written.

so imo we can close this issue

@evan-forbes evan-forbes added needs:grooming items needs a status change, to be closed, or clearer AC. Item should be discussed next sync. and removed needs:triage labels Jul 1, 2024
@staheri14
Copy link
Collaborator Author

Closing this in favour of a new issue created in the knuu repository. celestiaorg/knuu#474

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation needs:grooming items needs a status change, to be closed, or clearer AC. Item should be discussed next sync.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@staheri14 @evan-forbes