... | ... | @@ -11,7 +11,7 @@ Many thanks to [Octobus](https://octobus.net/) and [Clever Cloud](https://www.cl |
|
|
If you don't yet have a favourite Python editor, we recommend using [PyCharm community edition](https://www.jetbrains.com/pycharm/download/). PyCharm gives you easy code navigation and static checking. We've even added some PyCharm project settings to the Trosnoth repo so you can easily spin up a Trosnoth server, play a Trosnoth solo game, or run the test suite.
|
|
|
|
|
|
|
|
|
## Mercurial Workflow
|
|
|
## Workflow for Contributing
|
|
|
|
|
|
We use Mercurial for version control. To contribute to Trosnoth, you'll need to follow these steps:
|
|
|
|
... | ... | @@ -32,7 +32,7 @@ Note: until your topic has been accepted and merged into one of the main branche |
|
|
|
|
|
While you're working, it's good practice to regularly pull and rebase your topic (`hg rebase`; merging with `hg merge` is also acceptable). This ensures that you're always working from the latest approved changesets.
|
|
|
|
|
|
Your changes will be easier to review (so probably accepted more quickly) if you separate distinct changes into distinct commits. For example, if you're writing a new scenario and you need to add a new `Event` to the `Player` class, you could have one commit which defines the new event and triggers the event, and a separate commit containing the new scenario class and adding it to the scenario registry.
|
|
|
Your changes will be easier to review (so probably accepted more quickly) if you separate distinct changes into distinct commits. For example, if you're writing a new scenario and you need to add a new `Event` to the `Player` class, you could have one commit which defines the new event and triggers the event, and a separate commit containing the new scenario class and adding it to the scenario registry. You can use `hg split` to split a draft changeset into multiple commits after the fact.
|
|
|
|
|
|
Never commit changes to someone else's topic without their complete knowledge and consent—multiple people rewriting the history of the same topic can lead to situations that are complicated to resolve.
|
|
|
|
... | ... | |