joncampbell123/dosbox-x
1
0
Fork 0
mirror of https://github.com/joncampbell123/dosbox-x.git synced 2025-10-15 03:48:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Wengier
2020-08-28 00:20:24 -04:00
committed by GitHub
parent 2c7e1510d3
commit 22d6ecf594
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -5,14 +5,14 @@ Before contributing to DOSBox-X, please check the [issue tracker](https://github
## Scope of contributions that are welcome ## Scope of contributions that are welcome
- The normal operation of DOS games and applications within DOSBox-X - The normal operation of DOS games and applications within DOSBox-X
- DOS, Windows 3.x and Windows 9x/ME guest system support - DOS, Windows 1.0/2.x/3.x and Windows 9x/ME guest system support
- Architectural symmetry with a real DOS environment (particularly MS-DOS or PC DOS) - Architectural symmetry with a real DOS environment (particularly MS-DOS or PC DOS)
- Improving a platform-specific build of DOSBox-X or getting it on par with other platforms supported - Improving a platform-specific build of DOSBox-X or getting it on par with other platforms supported
- Non-implemented (or incorrectly) system calls - Non-implemented (or incorrectly) system calls
- Missing or incorrect hardware emulation, e.g. video, sound, input - Missing or incorrect hardware emulation, e.g. video, sound, input
- Bug fixes and/or improvements that allows for example demoscene productions to run in DOSBox-X - Bug fixes and/or improvements that allows for example demoscene productions to run in DOSBox-X
You do not necessarily need to be versed in coding, in this case you will certainly spend most of your time in the [issue tracker](https://github.com/joncampbell123/dosbox-x/issues); either submitting bugs or asking for new features. You can also help improve DOSBox-X's documentation or translate its language file to another language. You do not necessarily need to be versed in coding, in this case you will certainly spend most of your time in the [issue tracker](https://github.com/joncampbell123/dosbox-x/issues); either submitting bugs or asking for new features, or helping other DOSBox-X users by suggesting solutions to their problems. You can also help improve DOSBox-X's documentation, or translate its language file to another language.
## Code ## Code
@@ -29,6 +29,9 @@ Recommendations about coding:
Obviously when you'll dig in, you will quickly spot that there are many places where these rules are simply not followed ! Over the years, hundreds of people have worked on DOSBox (which DOSBox-X is a fork of), while that helped to raise this project to where it is today, it certainly didn't in terms of clean code. But keep the faith, a huge code cleanup endeavor has started with the goal to raise the metrics of DOSBox-X guts, hopefully ASAP. Obviously when you'll dig in, you will quickly spot that there are many places where these rules are simply not followed ! Over the years, hundreds of people have worked on DOSBox (which DOSBox-X is a fork of), while that helped to raise this project to where it is today, it certainly didn't in terms of clean code. But keep the faith, a huge code cleanup endeavor has started with the goal to raise the metrics of DOSBox-X guts, hopefully ASAP.
For details of the source code, please take a look at the [DOSBox-X source code description](README.source-code-description) page. Information about the debugger is also available in the [DOSBox-X Debugger](README.debugger) page.
## Code of Conduct ## Code of Conduct
Please read the [Code of Conduct](CODE_OF_CONDUCT.md) page. Please read the [Code of Conduct](CODE_OF_CONDUCT.md) page.