Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

feat: add document about EDC Best Practices #137

Merged
merged 5 commits into from
Apr 3, 2024

Conversation

paullatzelsperger
Copy link
Member

What this PR changes/adds

adds documentation of some Best Practices

Why it does that

documentation

Further notes

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Linked Issue(s)

Closes # <-- insert Issue number if one exists

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

@paullatzelsperger paullatzelsperger force-pushed the docs/add_best_practices branch from 956d403 to 111ea2f Compare March 30, 2024 09:58
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
Copy link
Contributor

@juliapampus juliapampus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be linked in the ToC or at least the dev's README, no?

@paullatzelsperger
Copy link
Member Author

Should be linked in the ToC or at least the dev's README, no?

good point, will add references.

Copy link
Contributor

@alexandrudanciu alexandrudanciu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested some minor improvements.

developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
developer/best_practices.md Outdated Show resolved Hide resolved
paullatzelsperger and others added 2 commits April 2, 2024 13:44
Co-authored-by: alexandrudanciu <80531692+alexandrudanciu@users.noreply.github.com>
@paullatzelsperger paullatzelsperger force-pushed the docs/add_best_practices branch from 0d4c328 to 80454f4 Compare April 2, 2024 11:46
developer/README.md Outdated Show resolved Hide resolved
docs/_sidebar.md Outdated Show resolved Hide resolved
@paullatzelsperger paullatzelsperger merged commit 6d2704d into main Apr 3, 2024
3 checks passed
@paullatzelsperger paullatzelsperger deleted the docs/add_best_practices branch April 3, 2024 14:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants