Skip to content

Commit de534bb

Browse files
authored
Merge pull request #1835 from passagemath/CONTRIBUTING-improvements
CONTRIBUTING.md: Expand and clarify
2 parents 3c87316 + ddebbee commit de534bb

File tree

1 file changed

+55
-3
lines changed

1 file changed

+55
-3
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@ passagemath is a compatible fork of SageMath.
44

55
We merge new releases of SageMath into passagemath on a regular basis.
66

7-
## Direct code contributions to passagemath (recommended)
7+
## Direct code/documentation contributions to passagemath (recommended)
88

99
On 2025-09-01, the passagemath project was opened to general
1010
code contributions. Submit pull requests to the [main passagemath
1111
repository](https://github.com/passagemath/passagemath) or other
1212
repositories in the [passagemath GitHub organization](https://github.com/passagemath).
1313

1414
PRs will be reviewed by the passagemath project's maintainer.
15+
Members of the passagemath organization and the general public are invited to
16+
contribute to reviewing PRs.
1517

1618
All participation in passagemath is subject to the Code of Conduct.
1719
Code contributions to passagemath are limited to those that
18-
support the goals of the fork outlined in [README.md](README.md).
20+
do not conflict with the goals of the fork outlined in [README.md](README.md).
1921

20-
## Code contributions to upstream SageMath (caution advised)
22+
## Code/documentation contributions to upstream SageMath (caution advised)
2123

2224
As we merge new releases of SageMath into passagemath on a regular basis,
2325
it is also possible to contribute to passagemath indirectly, by opening
@@ -49,9 +51,59 @@ are a basis for such efforts.
4951
- Use `git cherry-pick` or `git rebase --onto` to prepare a branch
5052
backported to the SageMath `develop` branch.
5153

54+
## Contributing to passagemath by backporting SageMath PRs
55+
56+
Although we already merge new releases of SageMath into passagemath on a
57+
regular basis, earlier backports of selected changes made in the SageMath
58+
project are welcome.
59+
60+
As passagemath makes frequent stable releases, in particular bug fixes
61+
in the Sage library, updates of packages in the Sage distribution, and
62+
portability improvements are good candidates for backporting to
63+
passagemath.
64+
65+
- Such PRs are best opened with a title in the form
66+
"ORIGINALTITLE by @ORIGINALAUTHOR, backported" or
67+
"ORIGINALTITLE by @ORIGINALAUTHOR, rebased".
68+
This ensures that the correct attribution is shown in the automatically
69+
generated release notes in https://github.com/passagemath/passagemath/releases
70+
71+
- Please include a link to the original PR in the description.
72+
There is no need to copy-paste the original description.
73+
74+
- Use `git cherry-pick` or `git rebase --onto` to prepare a branch
75+
backported to the passagemath `main` branch.
76+
5277
## Non-code contributions to passagemath
5378

5479
There are many other ways to contribute to the passagemath project.
5580

5681
For example, help popularize the project by sharing project announcements
5782
in mailing lists and on social media.
83+
84+
The passagemath project does not accept financial sponsorship.
85+
86+
## Contributing to the larger mathematical software ecosystem
87+
88+
The passagemath project is a major integrating force in the
89+
[mathematical software landscape](https://github.com/passagemath#passagemath-in-the-mathematical-software-landscape).
90+
91+
passagemath depends on numerous open-source mathematical software
92+
packages. Contributing to the development and maintenance of
93+
dependencies is a great way to contribute to passagemath, too.
94+
95+
Publishing your own packages that depend on passagemath is also a
96+
wonderful way to contribute to the passagemath project and the
97+
mathematical software ecosystem.
98+
99+
You are also invited to help with curation activities for mathematical
100+
software.
101+
102+
- For user packages that depend on the Sage library, curation
103+
activities are coordinated in
104+
[passagemath/passagemath#248](https://github.com/passagemath/passagemath/issues/248).
105+
106+
- Regarding other mathematical software, we invite the public to open
107+
an Issue at https://github.com/passagemath/passagemath/issues to
108+
describe the scope of the curation and initial examples of software
109+
to be surveyed.

0 commit comments

Comments
 (0)