Add comments about what is in scope for mathlib #526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcommelin
reviewed
Sep 18, 2024
fpvandoorn
reviewed
Feb 18, 2025
|
|
||
| ## Working on mathlib | ||
|
|
||
| If you believe that your code does belong in mathlib, you should open a PR. |
There was a problem hiding this comment.
This sentence duplicates the first sentence in the section Making a Pull Request (PR) and seems more fitting there.
fpvandoorn
approved these changes
Feb 18, 2025
| @@ -10,10 +10,23 @@ to make the process of contributing as smooth as possible. | |||
| - The explanation of [naming conventions](naming.html). | |||
| - The [documentation guidelines](doc.html). | |||
|
|
|||
| Once you have code that you'd like to contribute, you should open a PR. | |||
| ## What to contribute to mathlib | |||
There was a problem hiding this comment.
Somewhere you should also say: "Discuss on Zulip whether this is a good topic to add"
|
Actually, a third comment: Your discussion is only relevant when adding completely new things to Mathlib, while the page is about any Mathlib contributions (including small fixes or single-lemma additions). So it should be made clear that your new section doesn't always apply (and maybe the section should be later?) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think it would be slightly nicer to have a link to say "here is a big list of projects which depend on mathlib, please consider joining them", but right now this is waiting on leanprover/reservoir#49 . For now, I just link to the reservoir home page.