Skip to content

Commit b79098c

Browse files
[skip CI] Update contributing guide to PolyMath
1 parent 63872dc commit b79098c

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Contribution Guide for PolyMath
22

3-
This file is currently not complete but will be improve step by step.
3+
*This file is currently not complete but will be improve step by step.*
44

5-
# Contributing code
6-
Use last version of Pharo 8.0 in order to use Iceberg.
7-
## Fork the Pharo repository
5+
You need to download Pharo 8.0 first.
6+
7+
## Setup Iceberg
8+
You need an ssh key in order to commit on github. Open Iceberg tool, and then click on the settings. Check the box : "Use custom SSH keys".
9+
10+
## Fork the PolyMath repository
811

912
All changes you'll do will be versionned in your own fork of the [PolyMath repository](https://github.com/PolyMathOrg/PolyMath). Then, from your fork you'll be able to issue pull requests to PolyMath, where they will be reviewed, and luckily, integrated.
1013

11-
Go to PolyMath github's repository and click on the fork button on the top right. Yes, this means that you'll need a github account to contribute to PolyMath, yes.
14+
Go to PolyMath github's repository and click on the fork button on the top right. Yes, this means that you'll need a github account to contribute to PolyMath.
1215

1316
## Load last dev version of PolyMath
1417
In a fresh Pharo 8.0 image, load last development version of Polymath :
@@ -21,12 +24,29 @@ Metacello new
2124
```
2225
where you replace XXX with your github user name.
2326

24-
## Setup Iceberg
25-
You need an ssh key in order to commit on github. Open Iceberg tool, and then click on the settings. Check the box : "Use custom SSH keys".
27+
## Add main PolyMath repository as remote
28+
29+
Open Iceberg, open PolyMath repository, click on repositories, then + button (add remote).
30+
31+
Remote name: polymath-upstream
32+
33+
Remote URL: https://github.com/PolyMathOrg/PolyMath.git
34+
35+
## Send some changes to the original PolyMath repository
36+
37+
#### From Pharo Iceberg
38+
After doing modifications in your image, open Iceberg tool, commit the changes in your PolyMath repository. Cherry-pick the modifications that you want to include in your commit. Then push your commit to your fork. It's more convenient to divide your changes in meaninfull and simple commits, which makes it easier to check for those who need to proofread it.
39+
40+
#### From Github UI
41+
In the GitHub interface, create a Pull Request from your commit.
42+
You have to give some information about what is the purpose of you pull request. Then submit it to PolyMath main repository.
43+
This will notify PolyMath core developers team that an improvement or bug fix is pending.
44+
45+
### Sync your fork ull change from cormas/cormas in your own fork
46+
After a while, changes from other developers are integrated in the main PolyMath repository and your fork became out of sync.
47+
In order to do that, you need the fetch the last modifications from the main PolyMath repository, merge them in your image and then push them in your fork repository.
2648

27-
## Send the PR to github
28-
After doing the modification in your image, open Iceberg tool, commit the changes in your PolyMath repository. Cherry-pick the modifications that you want to include in your commit. In the github interface, create a Pull Request from your commit.
29-
Send the PR to PolyMath main repository.
49+
You have also the possibility to delete your fork and fork again the main PolyMath repository.
3050

3151
## Cleanups
3252
Ounce your pull request is integrated, some cleanups are required:

0 commit comments

Comments
 (0)