Contributing
You'll need to log in or join GitHub to contribute.
Not sure where to begin? Head over to our Discussion board and start a new thread! We're always happy to have new community members join the conversation.
Here is the thread for discussing these guidelines in particular.
If you have a specific improvement you'd like to see made to the pi-Base, you can always open an Issue that includes the following information:
- All spaces/properties/theorems related to your improvement, including their IDs (e.g. S012345). Links to https://topology.pi-base.org are encouraged.
- A description of the changes you'd recommend.
After discussion of your suggestion, any contributor can make a "Pull Request" (see below) to implement your improvement.
To add a pull request implementing any changes to the repository, fork this project to your own account, which creates a copy of https://github.com/pi-base/data/ to something like https://github.com/StevenClontz/pibase-data/.
The easiest way to edit your fork of the repository is to use GitHub.dev.
For example, if your fork is located at https://github.com/StevenClontz/pibase-data, you can either edit the URL to say
https://github.dev/StevenClontz/pibase-data (note the .dev), or press the period key on your physical keyboard
while viewing the repository to be redirected automatically. This opens a file editor in your web browser where you can make
whatever changes you'd like.
It's good to change the branch name from main to something like
UserName/describe-your-contribution. (Please do not use the | character or anything else
that is not allowed in a Windows filename.)
Then you can "commit & push" your changes to that branch on your fork.
When editing, be sure to review our conventions on notation and naming, and read below on information about references, our review criteria, etc.
Once you're happy with your changes, you can open up all pull request for review. Then one of our volunteer reviewers will check your work and discuss the proposed changes and any required effort necessary before they can be merged into the main data repository.
After you've made one or two contributions, you will likely be invited to make branches directly on the pi-base/data repository, so they are available to preview using https://topology.pi-base.org/dev
Contributions should generally reference a peer-reviewed publication, along with a Mathematical Reviews link or DOI link. Sometimes Wikipedia references are also appropriate.
pi-Base is not a forum for peer review, so to contribute improvements not directly reflected in the literature, we encourage you to ask (and self-answer if necessary) an appropriate question on either https://math.stackexchange.com/ or https://mathoverflow.net/, and use that as your citation.
Once you have been invited to help maintain the pi-Base (usually after one or two accepted pull requests) you are also welcome to help review new contributions!
Info for reviewers is at this page.
The copyright of all data in this repository is owned by Steven Clontz and James Dabbs and licensed for free public use under CC-BY-4.0. By contributing to the pi-Base, you agree that you grant Steven Clontz and James Dabbs an unlimited non-exclusive license to use your contribution as part of the pi-Base data repository. Please see LICENSE.md for details.