Skip to content

Commit 9456bc9

Browse files
committed
Update contrib process docs for 2025
Here we remove several defunct doku wiki and mantis links, and try to update these docs to more accurately reflect the current process.
1 parent 46b0391 commit 9456bc9

2 files changed

Lines changed: 42 additions & 35 deletions

File tree

crawl-ref/docs/develop/contribution-process.md

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,13 @@ board](https://tavern.dcss.io/c/back-room/gdd/9) (GDD) on the official
4141
Tavern forums. Please follow the GDD discussion guidelines posted at the top of
4242
that forum.
4343

44-
For planning and brainstorming, there is a [Doku development
45-
wiki](https://crawl.develz.org/wiki/doku.php) where anyone can register to
46-
create and edit wiki pages. This wiki is more useful if you're working on a
47-
larger project that's in need of outside ideas
48-
49-
An alternative to the Doku wiki is github wiki system. You can fork the crawl
50-
repository if you haven't done so already and create wiki pages in that fork.
51-
By default, github users who aren't collaborators for your repo can't edit wiki
52-
pages. You can allow other github users to edit your repository's wiki without
53-
allowing them commit access to the repository itself by going to the Settings
54-
tab of the repository and unchecking the box "Restrict editing to collaborators
55-
only". Finally, you can also add specific github users (such as a dev you are
56-
working with) to your repo's list of collaborators, which also grants them
57-
commit access in your repo.
44+
You could also try discussing your ideas in [any of the crawl community
45+
forums](../../../README.md#community), or wherever you might find other players.
46+
47+
Do note that crawl has a decades-long history: While we welcome new gameplay
48+
ideas, our desired changes may be substantially different from what you would
49+
want *as a player*. Try to consider the gameplay impact of your proposals from
50+
multiple perspectives, and be open to design feedback from devs.
5851

5952
## Development documentation and references
6053

@@ -72,20 +65,32 @@ WebTiles server is coded in python3 and uses the Tornado framework. The
7265
WebTiles browser client is written in JavaScript using the jQuery and other JS
7366
libraries. The local Tiles version uses the SDL2 graphics library.
7467

75-
If you're doing tiles art, or splash screen art, then it's recommended to look
76-
at previous artwork and try to match the general style presented there. This is
77-
not a hard-and-fast rule, and clear improvements are always welcome.
78-
7968
If you have questions for how to progress further, then feel free to pop into
8069
`#crawl-dev` and ask for help. Responses are reliant on dev availability and
8170
knowledge/expertise.
8271

72+
## Submitting artwork
73+
74+
If you want to submit artwork (tiles, icons, splash screens) for consideration,
75+
you can link it to us in `#crawl-dev`, or you can open a github issue, or you
76+
can submit a pull request.
77+
78+
If you're doing tiles art, or splash screen art, then it's recommended to look
79+
at our existing artwork and try to match the general style presented there. This
80+
is not a hard-and-fast rule, and clear improvements are always welcome.
81+
82+
However, there are some [hard requirements](tiles_creation.txt) on tile
83+
formatting and size: For most tiles, they need to be a 32 pixels by 32 pixels
84+
png file. Please see the tiles docs for further details; when in doubt, ask us.
85+
86+
If you're looking for a tile to work on, we maintain a standing list of art
87+
requests here: https://github.com/crawl/crawl/wiki/Art-Requests
88+
8389
## Submitting a pull request
8490

85-
The normal way to submit a contributing to crawl is by making Pull Request (PR)
91+
The normal way to submit a contribution to crawl is by making Pull Request (PR)
8692
on github. The technical parts of this process are fairly standard for any
87-
github-hosted project. We also will accept patches uploaded to mantis, but
88-
would prefer this to be limited to small changes like vaults or artwork.
93+
github-hosted project.
8994

9095
### A typical example of the process
9196

@@ -94,15 +99,17 @@ would prefer this to be limited to small changes like vaults or artwork.
9499
* Observe the [code style guidelines](coding_conventions.md) and [commit
95100
message style guidelines](coding_conventions.md#1---commit-conventions)
96101
(72 char width, line between title and body, bug # or reporter in title).
97-
* Include a commit message with meaningful content for every commit. It's
98-
fine if a PR comment duplicates this, but the priority for explaining the
99-
changes should be in the commit messages themselves.
102+
* Clearly explain *why* you are making the commit in the body of every
103+
commit message. It's fine if a PR comment duplicates this, but you should
104+
be explaining the context for your changes in the commit message itself.
100105
2. You open a PR in the main repository based on your branch.
101-
3. Some member(s) of the devteam reviews the commit, probably asking some
102-
questions and making some suggestions for changes. This happens at the pace
103-
of devteam availability, which can fluctuate. Be prepared to check in with devs
104-
from time to time to ask about your PR.
105-
4. You make some changes to your branch and push, which will automatically
106+
3. When you think your PR is ready for review, be proactive! Ask us about it,
107+
seek feedback, be responsive. Our time is limited and reviews will happen at
108+
the pace of developer availability, but sometimes a gentle nudge can help to
109+
keep things moving.
110+
4. Some member(s) of the devteam reviews the commit, probably asking some
111+
questions and making some suggestions for changes.
112+
5. You make some changes to your branch and push, which will automatically
106113
update the PR.
107114
* Devteam members won't make changes in a PR branch, and force-pushing to
108115
your fork's branch is fine. However, in some cases where changes were
@@ -111,8 +118,8 @@ would prefer this to be limited to small changes like vaults or artwork.
111118
requirement to rebase changes.
112119
* In branches we generally prefer rebasing on master rather than merge
113120
commits. However we can rebase your branch ourselves when merging.
114-
* Steps 3-4 may repeat.
115-
5. If all goes well, a devteam member merges the PR. This will typically
121+
* Steps 3-5 may repeat.
122+
6. If all goes well, a devteam member merges the PR. This will typically
116123
involve a rebase, and the devteam member may tweak some details of the
117124
commit(s) at this time, and potentially squash commits.
118125

crawl-ref/docs/develop/tiles_creation.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This document aims to give a simultaneously short and detailed explanation
55
about everything you need to know if you want to design tiles for Dungeon Crawl
66
Stone Soup. You can also find this text, and potentially a more up-to-date
77
version of it, at:
8-
http://crawl.develz.org/wiki/doku.php?id=dcss:help:tiles_creation
8+
https://github.com/crawl/crawl/blob/master/crawl-ref/docs/develop/tiles_creation.txt
99

1010

1111
Table of Contents
@@ -65,7 +65,7 @@ having access to existing ones, it can be useful to have them around for
6565
comparison.
6666

6767
You can download the latest source from the usual release site:
68-
http://sourceforge.net/projects/crawl-ref/files/
68+
https://github.com/crawl/crawl
6969

7070
To download the development version, you'll need to install and use git.
7171
See docs/develop/git/quickstart.txt for further instructions.
@@ -459,8 +459,8 @@ to said link.
459459
========================
460460

461461
To submit new tiles, please submit a pull request to our github
462-
(https://github.com/crawl/crawl/pulls), or contact one of our tiles developers
463-
(these currently include Sastreii and CanOfWorms).
462+
(https://github.com/crawl/crawl/pulls), contact us in #crawl-dev, or contact one
463+
of our tiles developers.
464464

465465
Please note that, unless you specify otherwise, tiles you submit to Crawl will
466466
be released under the CC0 license, which is similar to placing them in the

0 commit comments

Comments
 (0)