Skip to content

Commit

Permalink
CONTRIBUTING.md: initial checkin
Browse files Browse the repository at this point in the history
  • Loading branch information
austin987 committed Nov 15, 2017
1 parent 8c73df9 commit df25511
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to Winetricks

## License

Winetricks is licensed under the LGPL 2.1 or later. Sending a pull request indicates your willingness to license your contribution under this license.

## Coding standards
* Documented at top of ```src/winetricks```
* POSIX shell, no bash (maintainer's scripts can be python/bash)
* If something is unclear, ask

## Making a patch:
* Check out the source: ```git clone [email protected]:Winetricks/winetricks.git```
* Hack the source: ```vi src/winetricks```
* Test it: ```./src/winetricks -q -v foo```
* ```./tests/shell-checks```: MUST pass (Travis CI verifies)
* ```./tests/winetricks-test check```: optional but recommended, if you have the time and hard drive space this should be run

## Sending your patch:
* Commit:
* Commit should start with component affected, or misc/winetricks if generic, followed by a short summary:
```git commit -a -m 'vcrun2005: fix a typo'```
* Extended git logs are okay if more explanation is needed
* Send PR: https://github.com/Winetricks/winetricks/compare/
* If you are asked for changes:
* Edit the source/commit as appropriate: ```vi src/winetricks``` / ```git commit --amend -a```
* Force push ```git push -f your_org your_repo```
* Github will automatically update the Pull Request, but it WON'T send a notification.
* Make sure to comment/tag maintainer so he knows there's been an update

## Bug reports:
* Bug reports must contain, at a minimum:
* The winetricks version (printed at top of stdout, or use ```winetricks --version```)
* The wine version used (```wine --version```)
* The failing command (```winetricks foobar```)
* The terminal output, preferably as a .txt attachment
* Bug reports lacking this information may be closed without warning

* Feature requests should provided as much detail as possible, along with the tested Winetricks version

0 comments on commit df25511

Please sign in to comment.