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

Add documentation to "contribution" part of README #234

Open
widhalmt opened this issue Aug 15, 2023 · 0 comments
Open

Add documentation to "contribution" part of README #234

widhalmt opened this issue Aug 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@widhalmt
Copy link
Member

We have some rules in README.md. We should add, that every pull request must come with documentation for the change it introduces. Now is the time where we see more undocumented variables etc. .

And, as @xtruthx just experienced (sorry again for that), some more sophisticated parts of the code aren's as well documented as we all wished. So while using the collection seems to be quite straight forward, changes are hard because the more complex parts aren't easy to comprehend. Sometimes even usage is hard: See #218 for example.

@widhalmt widhalmt added the documentation Improvements or additions to documentation label Aug 15, 2023
@widhalmt widhalmt added this to the 0.1.0 milestone Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant