Skip to content

Contributing

Steven Clontz edited this page Apr 23, 2023 · 14 revisions

You'll need to log in or join GitHub to contribute.

Open an Issue

The easiest way to suggest an improvement is to open an Issue. Include 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.

Make a Pull Request

To add a pull request implementing any changes to the repository, fork this project to your own account, make whatever changes you'd like, then open up all pull request for review. Be sure to review our conventions on notation and naming.

In the near future, we will provide a way to automatically preview the results of pull requests at https://topology.pi-base.org. For now, you are welcome to open a pull request and ask a reviewer to set up this preview for you.

Our reviewers will check to make sure that PRs have proper references, and either suggest changes or merge them into master.

References

Ideally, contributions should 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.

Reviewers

These are our current reviewers. Please feel free to contact us with any questions.

  • Chris Caruvana, @ccaruvana
  • Steven Clontz, @StevenClontz
  • Patrick Rabau, @prabau
  • Lynne Yengulalp, @lyengulalp

Licensing

The copyright of all data in this repository - including any merged user contributions - is owned by James Dabbs and licensed for free public use under CC-BY-4.0. Please see LICENSE.md for details.

Clone this wiki locally