Skip to content

Commit ceae0a0

Browse files
committed
Extended README; new CONTRIBUTING.md, code cleanups
1 parent 74c4b6a commit ceae0a0

File tree

4 files changed

+161
-269
lines changed

4 files changed

+161
-269
lines changed

CONTRIBUTING.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to mutagen
2+
3+
Hi there! So you want to join the mutagen project or at least know what it entails? Welcome and read on!
4+
5+
## Getting started
6+
7+
High level approach:
8+
9+
1. Find something to fix/improve
10+
2. Change code, tests, docs, whatever
11+
3. If you changed code, run `cargo test` (once we have a test suite, that is) both in the `mutagen/` dir and the `plugin/` subdirectory.
12+
If you cannot get the code to build / tests to pass, don't fret, just mark your contribution as work in progress ("WIP").
13+
4. Open a pull request. For that you need to fork the repository. See [GitHub's help page](https://help.github.com/articles/fork-a-repo/)
14+
for more information.
15+
16+
### Finding something to fix/improve
17+
18+
All issues on mutagen are mentored, if you want help with an issue just ask @llogiq.
19+
20+
Some issues are easier than others. The [good first issue](https://github.com/llogiq/mutagen/labels/good%20first%20issue)
21+
label can be used to find the easy issues. If you want to work on an issue, please leave a comment to have it assigned
22+
to you.
23+
24+
### Writing code, tests, docs, etc.
25+
26+
All contributions are equally welcome, whether it's refactorings for a more readable codebase, fixing a bug or implementing
27+
new functionality, adding tests, documentation or setting up or improving CI, we'll be happy to have your contributions.
28+
29+
### Getting your contribution into mutagen
30+
31+
Contributions to mutagen should be made in the form of GitHub pull requests. Each pull request will
32+
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
33+
main tree or given feedback for changes that would be required.
34+
35+
All code in this repository is under either the [Apache License 2.0](LICENSE.Apache2) or the [MIT License](LICENSE.MIT).
36+
37+
## Conduct
38+
39+
We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
40+
41+
42+
<!-- adapted from https://github.com/rust-lang-nursery/rust-clippy/blob/master/CONTRIBUTING.md -->

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Breaking your Rust code for fun & profit
22

3-
This is a work in progress mutation testing framework. The idea behind
4-
mutation testing is to insert changes into your code to see if they
5-
make your tests fail. If not, your tests obviously fail to test the
6-
changed code.
3+
This is a work in progress mutation testing framework. Not all components are there, those that are there aren't finished, but you can see the broad direction it's going to take.
74

8-
This repo has two components at the moment: A helper library and a
9-
procedural macro that mutates your code.
5+
### Mutation Testing
106

11-
issues and PRs welcome!
7+
The idea behind mutation testing is to insert changes into your code to see if they make your tests fail. If not, your tests obviously fail to test the changed code.
8+
The difference to line or branch coverage is that those measure if the code under test was *executed*, but that says nothing about whether the tests would have caught any error.
9+
10+
This repo has two components at the moment: A helper library and a procedural macro that mutates your code.
11+
12+
### Contributing
13+
14+
issues and PRs welcome! See [CONTRIBUTING.md] on how to help.

0 commit comments

Comments
 (0)