-
Notifications
You must be signed in to change notification settings - Fork 297
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
[Merged by Bors] - doc(algebraic_hierarchy): advice for adding new typeclasses #6854
Conversation
…thlib into hierarchy_design
This looks great, thanks for writing it. I think it might also be helpful to include a some guidance about how to PR the work. E.g., one could:
Until recently, my experience has been that Mathlib has prospered with approach 4 but this may be changing. |
I've tried to address this in 8092aa0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! It's not complete but it's already a great resource. We should keep working on this and keep it up to date; particularly as Lean 4 approaches.
bors r+
This is not intended as document describing all the design decisions behind our algebraic hierarchy, but rather some advice for contributors adding new typeclasses. It can hopefully serve as a checklist for instances and definitions that should be made for any new algebraic structure being added to mathlib. Please edit as you see fit, contribute new sections, etc. I haven't written anything yet about interactions with topology or order structures. Please consider this an invitation, or otherwise we can delete those headings later. Thanks to @eric-wieser for providing the list of instances needed for each typeclass! Co-authored-by: Scott Morrison <scott.morrison@gmail.com> Co-authored-by: Yury G. Kudryashov <urkud@urkud.name> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
Pull request successfully merged into master. Build succeeded: |
This is not intended as document describing all the design decisions behind our algebraic hierarchy, but rather some advice for contributors adding new typeclasses. It can hopefully serve as a checklist for instances and definitions that should be made for any new algebraic structure being added to mathlib. Please edit as you see fit, contribute new sections, etc. I haven't written anything yet about interactions with topology or order structures. Please consider this an invitation, or otherwise we can delete those headings later. Thanks to @eric-wieser for providing the list of instances needed for each typeclass! Co-authored-by: Scott Morrison <scott.morrison@gmail.com> Co-authored-by: Yury G. Kudryashov <urkud@urkud.name> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
This is not intended as document describing all the design decisions behind our algebraic hierarchy, but rather some advice for contributors adding new typeclasses.
It can hopefully serve as a checklist for instances and definitions that should be made for any new algebraic structure being added to mathlib.
Please edit as you see fit, contribute new sections, etc. I haven't written anything yet about interactions with topology or order structures. Please consider this an invitation, or otherwise we can delete those headings later.
Thanks to @eric-wieser for providing the list of instances needed for each typeclass!