Skip to content

Commit fa4ba01

Browse files
committed
Linted the remaining files.
1 parent c52a709 commit fa4ba01

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

CONTRIBUTING.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,37 @@
1-
Contributing
2-
==
1+
# Contributing
2+
33
Glad to see you're interested in contributing to Reko. Being a small team, all help is appreciated.
44

5-
What can you do?
6-
--
7-
* If you have an exciting idea for a feature, a question about how Reko works, or have found a bug in Reko,
5+
## What can you do?
6+
7+
* If you have an exciting idea for a feature, a question about how Reko works, or have found a bug in Reko,
88
please open an [issue](http://github.com/uxmal/reko/issues) so we know about it.
99
* If you feel an urge to code, submit a pull request. Please make an effort to provide one or more unit tests
1010
along with your code.
1111

12-
Unit tests
13-
--
14-
When contributing code we request that you submit one or more unit tests that exercise
12+
## Unit tests
13+
14+
When contributing code we request that you submit one or more unit tests that exercise
1515
the code you added or modified. Because of the size and complexity of the Reko project, it is critical that
16-
we manage changes with proper tests to ensure that no existing code is being broken.
16+
we manage changes with proper tests to ensure that no existing code is being broken.
1717

1818
We use [NUnit 2.6](http://www.nunit.org/) as our test framework.
1919

2020
To make the unit tests suite run as fast as possible (at the time of writing, there are 3462 unit tests)
2121
they should avoid reading or writing large amounts of data from disk. A unit test should be as "quiet"
22-
as possible. Avoid output to stdout/stderr, and avoid using `Debug.Write` and friends **if the
22+
as possible. Avoid output to stdout/stderr, and avoid using `Debug.Write` and friends **if the
2323
unit test passes**. If the unit test **fails**, diagnostic output to stdout or using `Debug.Write` is
2424
encourage to aid in diagnosis.
2525

26-
Submitting a pull request (PR)
27-
--
28-
Once the unit tests pass, there is a final step: run all the regression tests on the test subjects.
29-
The test subjects are executable files, located in the `./subjects` folder of the Reko project tree.
26+
## Submitting a pull request (PR)
27+
28+
Once the unit tests pass, there is a final step: run all the regression tests on the test subjects.
29+
The test subjects are executable files, located in the `./subjects` folder of the Reko project tree.
3030
Run the Python script `./subjects/regressionTests.py` to exercise all the test programs. The script will
3131
run the command-line version of Reko on the subjects, which generates output files for each subject.
3232

33-
If your code changes resulted in the outputs also changing, you will need to review them to make sure that
33+
If your code changes resulted in the outputs also changing, you will need to review them to make sure that
3434
all differences make sense, and that no regressions have occurred.
3535

3636
Once you've reviewed any changes in the `./subjects` tree and have committed any differences, you can
37-
submit the PR.
38-
39-
37+
submit the PR.

NEWS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
* Combined code and low-level viewer, to allow users to compare Reko's output
66
with the original binary.
7-
* A graph viewer, to help users to visualize procedure call graph
8-
* Image map view shows an overview of the image bytes as pixels
7+
* A graph viewer, to help users to visualize procedure call graph
8+
* Image map view shows an overview of the image bytes as pixels
99
* Allow user to specify the encoding used for text when displaying character data
1010
* New reko configuration and project file formats
1111
* Improvements in user-specified data types
@@ -35,7 +35,7 @@
3535

3636
### Version 0.5.3.0
3737

38-
* Support for the MIPS architecture, and MIPS support in the
38+
* Support for the MIPS architecture, and MIPS support in the
3939
PE and ELF image format
4040
* TextViewer now supports free selection of text.
4141

TODO.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
# TODO
2+
13
The current version of Reko is quite crude and could use assistance.
24

35
* Support for more processor architectures and platforms. Currently Reko
4-
has support for x86, Motorola 68k, and MS-DOS, Win32, ELF, and Hunk
6+
has support for x86, Motorola 68k, and MS-DOS, Win32, ELF, and Hunk
57
executable formats. See the "How to..." wiki page for how to contribute
68
new architectures and platforms.
79

0 commit comments

Comments
 (0)