Skip to content

Commit d6d4227

Browse files
committed
CONTRIBUTING.md: initial checkin
1 parent 8c73df9 commit d6d4227

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

Diff for: CONTRIBUTING.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to Winetricks
2+
3+
## License:
4+
Winetricks is licensed under the LGPL 2.1 or later. Sending a pull request indicates your willingness to license your contribution under this license.
5+
6+
## Coding standards:
7+
* Documented at top of ```src/winetricks```
8+
* POSIX shell, no bash (maintainer's scripts can be python/bash)
9+
* If something is unclear, ask
10+
11+
## Making a patch:
12+
* Check out the source: ```git clone [email protected]:Winetricks/winetricks.git```
13+
* Hack the source: ```vi src/winetricks```
14+
* Test it:
15+
* Ideally, Winetricks should work under any Wine version. In practice, testing against the current development and stable versions is sufficient.
16+
* If a bug is only present in some Wine versions, w_workaround_bug() should be used
17+
* ```./src/winetricks -q -v foo```
18+
* ```./tests/shell-checks```: MUST pass (Travis CI verifies)
19+
* This tool uses checkbashisms (package `devscripts` on Debian-based distributions) and [ShellCheck](https://github.com/koalaman/shellcheck)
20+
* If ShellCheck fails, see [ShellCheck wiki](https://github.com/koalaman/shellcheck/wiki) and fix/[ignore](https://github.com/koalaman/shellcheck/wiki/Ignore) the error(s)
21+
* Detailed error information is available in the wiki (e.g. [SC2154](https://github.com/koalaman/shellcheck/wiki/SC2154))
22+
* ```./tests/winetricks-test check```: optional but recommended, if you have the time and hard drive space this should be run
23+
24+
## Sending your patch:
25+
* Commit:
26+
* Commit should start with component affected, or misc/winetricks if generic, followed by a short summary:
27+
```git commit -a -m 'vcrun2005: fix a typo'```
28+
* If you add a new verb, use the format: `verb_name: new verb(, description...)`
29+
* Extended git logs are okay if more explanation is needed
30+
* Send PR: https://github.com/Winetricks/winetricks/compare/
31+
* If you are asked for changes:
32+
* Edit the source/commit as appropriate: ```vi src/winetricks``` / ```git commit --amend -a```
33+
* Force push ```git push -f your_org your_repo```
34+
* Github will automatically update the Pull Request, but it WON'T send a notification.
35+
* Make sure to comment/tag maintainer so he knows there's been an update
36+
37+
## Bug reports:
38+
* Bug reports must contain, at a minimum:
39+
* The Winetricks version (printed at top of stdout, or use ```winetricks --version```)
40+
* The Wine version used (```wine --version```)
41+
* The failing command (```winetricks foobar```)
42+
* The terminal output, preferably as a ```.txt``` attachment
43+
* Bug reports lacking this information may be closed without warning
44+
45+
* Feature requests should provide as much detail as possible, along with the tested Winetricks version

0 commit comments

Comments
 (0)