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

Rewrite contributing.md #760

Merged
merged 4 commits into from
Oct 21, 2024
Merged

Conversation

kellertuer
Copy link
Member

Resolves #750.

@Affie can you take a look whether this is clearer now? I especially added an overview of files to consider when contributing.
Another Idea I can do, is to give a super short summary of what to do and which files to consider in the beginning of https://juliamanifolds.github.io/ManifoldsBase.jl/stable/tutorials/implement-a-manifold/, but that is something for another PR in that repository.

This also initialises vale.sh as a linter for the text to improve style and easier find bugs, since vale also highlights hints and errors in VS code when using their plugin. Vale is not perfect but maybe a good guide.

Copy link

codecov bot commented Oct 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.39%. Comparing base (b3c0fa4) to head (9636973).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #760   +/-   ##
=======================================
  Coverage   96.39%   96.39%           
=======================================
  Files         123      123           
  Lines       11441    11441           
=======================================
  Hits        11028    11028           
  Misses        413      413           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kellertuer kellertuer added Ready-for-Review A label for pull requests that are feature-ready discussion labels Oct 20, 2024
@Affie
Copy link
Contributor

Affie commented Oct 21, 2024

Hi, yes the overview with the links will help a lot. I'm guessing the group "how to" will go into "LieGroups.jl". Perhaps when that is done, I should try to contribute the SpecialGalileanGroup we have here (if you want it): https://github.com/JuliaRobotics/RoME.jl/blob/master/src/factors/Inertial/IMUDeltaFactor.jl
I can follow the guide and let you know where I get stuck.

@kellertuer
Copy link
Member Author

Nice!

Yes I plan to write a “How to Lie Group” once we have at least group operations fixed in LieGroups.jl, which should not take so long I hope – the first Lie group is nearly done. I want to do a second to be safe, and use that to write a tutorial.

But sure, new Lie groups are then super welcome over there!

@kellertuer kellertuer merged commit 45b9cfa into master Oct 21, 2024
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Ready-for-Review A label for pull requests that are feature-ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(Update / Improve) A Developer guide
2 participants