|
1 |
| -Contributing |
2 |
| -============ |
| 1 | +# Contributing |
3 | 2 |
|
4 |
| -There's several ways to contribute to the project: reporting bugs, sending feedback, proposing ideas for new features, fixing or adding documentation, promoting the project, or even contributing code. |
| 3 | +There are several ways to contribute to the project: reporting bugs, sending |
| 4 | +feedback, proposing ideas for new features, fixing or adding documentation, |
| 5 | +promoting the project, or even contributing code. |
5 | 6 |
|
6 | 7 | ## Reporting issues
|
7 | 8 |
|
8 | 9 | You can report issues [here](https://github.com/ba-st/Kepler/issues/new)
|
9 | 10 |
|
10 | 11 | ## Contributing Code
|
| 12 | + |
11 | 13 | - This project is MIT licensed, so any code contribution MUST be under the same license.
|
12 |
| -- This project uses [Semantic Versioning](http://semver.org/), so keep it in mind when you make backwards-incompatible changes. If some backwards incompatible change is made the major version MUST be increased. |
13 |
| -- The source code is hosted in this repository using the Tonel format in the `source` folder. |
14 |
| -- The `release-candidate` branch contains the latest changes and should always be in a releasable state. |
| 14 | +- This project uses [Semantic Versioning](http://semver.org/), so keep it in |
| 15 | + mind when you make backwards-incompatible changes. If some backwards |
| 16 | + incompatible change is made the major version MUST be increased. |
| 17 | +- The source code is hosted in this repository using the Tonel format in the |
| 18 | + `source` folder. |
| 19 | +- The `release-candidate` branch contains the latest changes and should always |
| 20 | + be in a releasable state. |
15 | 21 | - Feel free to send pull requests or fork the project.
|
16 |
| -- Code contributions without test cases have a lower probability of being merged into the main branch. |
17 |
| - |
18 |
| -### Using Iceberg |
19 |
| -1. Download a [Pharo Image and VM](https://get.pharo.org/64) |
20 |
| -2. Clone the project or your fork using Iceberg |
21 |
| -3. Open the Working Copy and using the contextual menu select `Metacello -> Install baseline...` |
22 |
| -4. Input `Development` |
23 |
| -5. This will load the base code and the test cases |
24 |
| -6. Create a new branch to host your code changes |
25 |
| -7. Do the changes |
26 |
| -8. Run the test cases |
27 |
| -9. Commit and push your changes to the branch using the Iceberg UI |
28 |
| -10. Create a Pull Request against the `release-candidate` branch |
| 22 | +- Code contributions without test cases have a lower probability of being merged |
| 23 | + into the main branch. |
| 24 | + |
| 25 | +1. [Load the project code in a Pharo image](docs/how-to/how-to-load-in-pharo.md) |
| 26 | +2. Create a new branch to host your code changes |
| 27 | +3. Do the changes |
| 28 | +4. Run the test cases |
| 29 | +5. Commit and push your changes to the branch using the Iceberg UI. You may need |
| 30 | + to add your fork if lacking the required permissions to push to the main repo. |
| 31 | +6. Create a Pull Request against the `release-candidate` branch |
29 | 32 |
|
30 | 33 | ## Contributing documentation
|
31 | 34 |
|
32 |
| -The project documentation is maintained in this repository in the `docs` folder and licensed under CC BY-SA 4.0. To contribute some documentation or improve the existing, feel free to create a branch or fork this repository, make your changes and send a pull request. |
| 35 | +The project documentation is maintained in this repository in the `docs` folder |
| 36 | +and licensed under CC BY-SA 4.0. To contribute some documentation or improve the |
| 37 | +existing, feel free to create a branch or fork this repository, make your |
| 38 | +changes and send a pull request. |
0 commit comments