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

Better documentation for developers #375

Closed
lars-reimann opened this issue Jun 23, 2023 · 1 comment · Fixed by #427
Closed

Better documentation for developers #375

lars-reimann opened this issue Jun 23, 2023 · 1 comment · Fixed by #427
Assignees
@zzril @robmeth
Labels
documentation 📖 Improvements or additions to documentation released Included in a release

Comments

@lars-reimann
Copy link
Member

lars-reimann commented Jun 23, 2023 •
edited
Loading

  • Improve guidelines
    • Tests should be parametrized and should have IDs
    • Don't mutate objects but return new ones. Also explain how the docstring should be formatted
    • Sort __all__ in __init__.py alphabetically
  • Add other resources that would help onboarding new developers
    • Example: A checklist for code review (?)
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Jun 23, 2023
@github-project-automation github-project-automation bot moved this to Backlog in Library Jun 23, 2023
@lars-reimann lars-reimann moved this from Backlog to Todo in Library Jun 30, 2023
@zzril zzril linked a pull request Jul 6, 2023 that will close this issue
docs: Better documentation for developers #427
Merged
@zzril zzril mentioned this issue Jul 6, 2023
Merged
@zzril zzril moved this from Todo to In Progress in Library Jul 6, 2023
@zzril zzril moved this from In Progress to Ready for Review in Library Jul 9, 2023
lars-reimann added a commit that referenced this issue Jul 10, 2023
@zzril @lars-reimann
docs: Better documentation for developers (#427)
2c54ec0 
Closes #375.

### Summary of Changes

* Improved developer documentation about tests
* Added guidelines about copying objects (rather than modifying them
in-place)
* Added code-style guidelines
* Added code review guidelines

---------

Co-authored-by: Lars Reimann <[email protected]>
@github-project-automation github-project-automation bot moved this from Ready for Review to ✔️ Done in Library Jul 10, 2023
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.15.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zzril zzril

@robmeth robmeth

Labels
documentation 📖 Improvements or additions to documentation released Included in a release
Projects
Library
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Better documentation for developers Safe-DS/Library
3 participants
@lars-reimann @zzril @robmeth