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

docs: Better documentation for developers #427

Merged
merged 29 commits into from
Jul 10, 2023
Merged

docs: Better documentation for developers #427

merged 29 commits into from
Jul 10, 2023

Conversation

zzril
Copy link
Contributor

@zzril zzril commented Jul 6, 2023 •
edited
Loading

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

@zzril zzril linked an issue Jul 6, 2023 that may be closed by this pull request
Better documentation for developers #375
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2023 •
edited
Loading

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdown-link-check 2 0 1.81s
✅ REPOSITORY git_diff yes no 0.09s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@codecov
Copy link

codecov bot commented Jul 6, 2023 •
edited
Loading

Codecov Report

Merging #427 (d3d6010) into main (bc73a6c) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #427   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           48        48           
  Lines         2514      2514           
=========================================
  Hits          2514      2514

@zzril zzril mentioned this pull request Jul 6, 2023
Closed
@zzril zzril mentioned this pull request Jul 6, 2023
Closed
@zzril zzril requested a review from jxnior01 July 8, 2023 13:44
jxnior01
jxnior01 previously approved these changes Jul 9, 2023
View reviewed changes
Copy link
Contributor

@jxnior01 jxnior01 left a comment

Choose a reason for hiding this comment

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

Nice work!!

@zzril
Copy link
Contributor Author

zzril commented Jul 9, 2023 •
edited
Loading

The code style section got somewhat small. Turns out we don't really have a common code style except for "do what the linter says".
Thought about adding an FAQ for developers, but I only came up with like 3 questions. That didn't seem enough, so I dropped the idea.

Don't have any other ideas, so let me mark this as ready for review.

@zzril zzril marked this pull request as ready for review July 9, 2023 13:37
@zzril zzril requested a review from a team as a code owner July 9, 2023 13:37
@zzril zzril requested a review from lars-reimann July 9, 2023 13:37
lars-reimann
lars-reimann requested changes Jul 10, 2023
View reviewed changes
Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

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

Looks great overall, just some minor suggestions.

docs/development/guidelines.md Outdated Show resolved Hide resolved
docs/development/guidelines.md Outdated Show resolved Hide resolved
docs/development/guidelines.md Outdated Show resolved Hide resolved
docs/development/guidelines.md Outdated Show resolved Hide resolved
docs/development/guidelines.md Outdated Show resolved Hide resolved
docs/development/code_review.md Outdated Show resolved Hide resolved
docs/development/code_review.md Outdated Show resolved Hide resolved
docs/development/code_review.md Outdated Show resolved Hide resolved
docs/development/code_review.md Outdated Show resolved Hide resolved
docs/development/code_review.md Outdated Show resolved Hide resolved
zzril and others added 6 commits July 10, 2023 16:13
@zzril @lars-reimann
Apply suggestions from code review
e34ce7e 
Co-authored-by: Lars Reimann <[email protected]>
@zzril
Resolve issues mentioned in code review
db0267d
@zzril
Resolve issues mentioned in code review
576abde 
Those were already hidden in GitHub's UI.
@zzril
Remove dead link temporarily
642543b 
Linter reports this as a dead link.

Need to first merge this issue and host the new docs on the website,
then add the link in a second issue.
@zzril
Apply renaming suggestions from code review
93053e1
@zzril
Restructure test section
81767ee
@zzril zzril requested a review from lars-reimann July 10, 2023 16:09
@lars-reimann lars-reimann force-pushed the 375-better-documentation-for-developers branch from 3540785 to 2e96f51 Compare July 10, 2023 20:09
lars-reimann
lars-reimann approved these changes Jul 10, 2023
View reviewed changes
Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

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

Excellent work, thanks!

LGTM

@lars-reimann lars-reimann merged commit 2c54ec0 into main Jul 10, 2023
@lars-reimann lars-reimann deleted the 375-better-documentation-for-developers branch July 10, 2023 20:16
@zzril zzril mentioned this pull request Jul 10, 2023
Merged
lars-reimann pushed a commit that referenced this pull request Jul 11, 2023
@zzril
docs: Fix broken link in README.md (#442)
44005f4 
Closes #441.

### Summary of Changes

Fixed the broken link to our project guidelines in our README, which was
a regression from #427.
@lars-reimann
Copy link
Member

🎉 This PR is included 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
Reviewers

@lars-reimann lars-reimann lars-reimann approved these changes

@jxnior01 jxnior01 jxnior01 left review comments

Assignees
No one assigned
Labels
released Included in a release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Better documentation for developers
3 participants
@zzril @lars-reimann @jxnior01