How to make a proper Pull Request to add Planar Maps in Sage

[Victor Lrc]

Hello,

We are a group of students, and as part of a project, we have written a library for SageMath that implements planar maps (see, for example, https://www.irif.fr/~chapuy/AEC/coursHagenberg.pdf).

We have already implemented a number of classes, methods, and visualizations, and we hope to produce a final version of the code within a month or two, integrating it into SageMath.

Could you please guide us on the steps to follow beyond simply submitting a "Pull Request" to ensure a smooth integration? Are there any tests that need to be passed?

Our code is available in two versions:
- As an independent library of .sage files (i.e., the files need to be loaded before use) here: https://github.com/vicllo/PlanarMaps
- Already integrated into a Sage version (which therefore needs to be built from scratch) here: https://github.com/vicllo/sage

Best regards,
Victor

[Jackson Walters]

Is your repository PlanarMaps private? The link doesn't seem to be working.

Best,

Jackson

--
You received this message because you are subscribed to the Google Groups "sage-support" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sage-support...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/sage-support/e7e88d30-250a-4246-8454-96e3937ceea8n%40googlegroups.com.

[Victor Lrc]

Hello,

It was in fact private... I juste made it public sorry 

https://github.com/vicllo/PlanarMaps

Best, 

Victor

[Jackson Walters]

Perfect, I am able to see it now. It looks like there are at least a few thousand lines of code. I'm not the best person to answer this, but I'm first wondering if you want to do this all in one PR, or would you be able to break this up into multiple PRs in a modular fashion?

I can say that for (each) PR you would want to have the appropriate documentation, and this includes importantly doctests for everything you are implementing. As long as that is the case, and what you are proposing is not covered by existing code, it should be fairly straightforward. The tests that need to pass are the CI tests that Sage uses, which are a suite of tests across different builds. If your code doesn't impact other parts of the code, then as long as your code is working, they should pass.

HTH,

Jackson

To view this discussion visit https://groups.google.com/d/msgid/sage-support/c3579017-0f1e-4079-8291-7b9736cc0a31n%40googlegroups.com.