Mirrors/openrw
1
0
Fork 0
mirror of https://github.com/rwengine/openrw.git synced 2024-11-07 03:12:36 +01:00
Code Issues Projects Releases Activity

Merge pull request #213 from danhedron/update-docs

Browse Source 
Update docs
This commit is contained in:
Daniel Evans 2016-08-23 00:31:16 +01:00 committed by GitHub
commit 772876afdb
2 changed files with 12 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
CONTRIBUTING.md
View File

@ -1,48 +1,5 @@
## Who can contribute?
OpenRW is a community driven project, we are open to contributions from anyone
who cares to submit a pull request. Members of the community can provide their
input on reviewing open pull requests to make sure the changes work for them.
Once a pull request has been vetted, a member with the appropriate rights will
accept it into the code base.
GitHub moderation privileges may be granted to active contributors who display a
good ability to moderate in their issues and pull requests.
## See what's happening
Make sure to drop into the IRC channel #openrw on chat.freenode.net for discussion
about features in development.
## How to contribute
If you can write source code to implement missing features or fix bugs, changes
can be submitted for review via GitHub's pull requests system.
If you aren't able to contribute source code, we are also happy to see improved
documentation of the expected behaviour on sites like the gtamodding wiki.
Improving this documentation makes it easier to implement the correct behaviour.
## Submitting Pull Requests
If you are submitting a pull request for OpenRW:
1. Include a reference to any issue the pull request is intended to address.
2. Submit unrelated changes in different pull requests.
3. If you aren't ready to merge your changes but are looking for feedback, include "[not ready]" in the title.
4. Changes in behaviour should be shown to match the behaviour in the original game, if applicable.
5. Ensure that the test suite still passes after your change, updating tests if required.
## Guidelines
### What will be accepted
* Changes that increase compatibility with the game data.
* Fixes for technical issues, such as wide-screen or UHD resolution support.
* Feature enhancements, such as improved support for different input schemes.
### What will not be accepted
* Changes where the ownership of the code is in question.
* Changes to support non-GTA titles.
## Evaluating pull requests
Pull requests should be reviewed by as many people as possible for merging.
Ideally at least two active contributors should review the changes before it is
accepted, including the person who will accept the pull request.
# How to contribute
To find out how to report bugs or contribute code, please read the [contributing](https://github.com/rwengine/openrw/wiki/Contributing)
page. This page covers what types of contributions we are looking to encourage.

21
README.md
View File

@ -5,25 +5,22 @@
OpenRW is an open source re-implementation of Rockstar Games' Grand Theft Auto III,
a classic 3D action game first published in 2001.
A legitimate copy of the original PC game is required to run OpenRW. Without
this it will not be possible to play.
## Links
* [FAQ](https://github.com/rwengine/openrw/wiki/FAQ)
* [Getting Started](https://github.com/rwengine/openrw/wiki/Getting-Started)
* [Completable Missions](https://github.com/rwengine/openrw/issues/52)
* [Contributing](https://github.com/rwengine/openrw/wiki/Contributing)
* IRC: #openrw @ chat.freenode.net
Check out the [FAQ](https://github.com/rwengine/openrw/wiki/FAQ) and the rest of the [wiki](https://github.com/rwengine/openrw/wiki). Report any bugs by creating an [issue](https://github.com/rwengine/openrw/issues).
OpenRW requires a legitimate copy of the original PC game data in order to run.
Without this data it will not be possible to run OpenRW.
## Screenshots
![Looking west to Staunton](https://cloud.githubusercontent.com/assets/418211/16398933/40a62c20-3cc6-11e6-8c6a-9c50de47510c.png)
![Poor driving skill](https://cloud.githubusercontent.com/assets/418211/16398932/40a03de2-3cc6-11e6-9e48-acc9b44a600a.png)
![Duplicate claude in cutscene](https://cloud.githubusercontent.com/assets/418211/16399129/aa019d52-3cc7-11e6-9a33-a9fcce0b972c.png)
## Links
* [Getting Started](https://github.com/rwengine/openrw/wiki/Getting-Started)
* [FAQ](https://github.com/rwengine/openrw/wiki/FAQ)
* [Completable Missions](https://github.com/rwengine/openrw/issues/52)
* [Contributing](https://github.com/rwengine/openrw/wiki/Contributing)
## License
This program is free software: you can redistribute it and/or modify