... | ... | @@ -15,7 +15,7 @@ If you don't yet have a favourite Python editor, we recommend using [PyCharm com |
|
|
|
|
|
We use Mercurial for version control. To contribute to Trosnoth, you'll need to follow these steps:
|
|
|
|
|
|
1. Ask for developer access to the Heptapod project. To do this, [create a ticket](https://foss.heptapod.net/games/trosnoth/-/issues/new) using the ‘discussion’ template, and say that you'd like to contribute.
|
|
|
1. Ask for developer access to the Trosnoth project on Heptapod. To do this, [create a ticket](https://foss.heptapod.net/games/trosnoth/-/issues/new) using the ‘discussion’ template, and say that you'd like to contribute.
|
|
|
|
|
|
2. Clone the Trosnoth repository: `hg clone ssh://hg@foss.heptapod.net/games/trosnoth`
|
|
|
|
... | ... | @@ -28,15 +28,15 @@ We use Mercurial for version control. To contribute to Trosnoth, you'll need to |
|
|
6. Once you've completed your work, [create a merge request](https://foss.heptapod.net/games/trosnoth/-/merge_requests/new). Reference the related ticket in your merge request.
|
|
|
|
|
|
|
|
|
Note: until your topic has been accepted and merged into one of the main branches, the changesets will be mutable. This means that you can safely use Mercurial's history-rewriting operations on it. For more information on history rewriting, see [this document](*https://www.mercurial-scm.org/doc/evolution/index.ht)https://www.mercurial-scm.org/doc/evolution/index.html).
|
|
|
Note: until your topic has been accepted and merged into one of the main branches, the changesets will be mutable. This means that you can safely use Mercurial's history-rewriting operations on it. For more information on history rewriting, see [this document](https://www.mercurial-scm.org/doc/evolution/index.html).
|
|
|
|
|
|
While you're working, it's good practice to regularly pull and rebase your topic (`hg rebase`; merging is also acceptable: `hg merge`). This ensures that you're always working from the latest approved changesets.
|
|
|
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.
|
|
|
|
|
|
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.
|
|
|
|
|
|
Please don't use history rewriting operations on changesets that someone else has authored, even if you're working on your own topic. Doing so would result in a changeset being attributed to someone else even though you have edited it. If you have an edit to make to someone else's draft work, either commit a new changeset with your work, or ask the original author to amend their work. If you want to rebase someone else's work, use a merge instead, or ask the original author to rebase it.
|
|
|
Please don't use history rewriting operations on changesets that someone else has authored, even if you're working on your own topic. Doing so would result in a changeset being attributed to someone else even though you have edited it. If you have an edit to make to someone else's draft work, either make a new commit with your edits, or ask the original author to amend their work. If you want to rebase someone else's work, use a merge instead, or ask the original author to rebase it.
|
|
|
|
|
|
|
|
|
## Communication
|
... | ... | @@ -50,7 +50,7 @@ Please don't use history rewriting operations on changesets that someone else ha |
|
|
|
|
|
Once you've got your IDE set up, and cloned the repository, you'll need to install the dependencies. Dependencies for the development version of Trosnoth are:
|
|
|
|
|
|
* Python 3.6+
|
|
|
* Python 3.8+
|
|
|
* Twisted (16.0 or newer)
|
|
|
* Pygame
|
|
|
* If on Windows, pywin32
|
... | ... | |