Skip to content

Commit 548eff1

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

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

Diff for: CONTRIBUTING.md

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

0 commit comments

Comments
 (0)