Skip to content

Commit

Permalink
docs: update CHANGELOG and add contributing section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
m4b committed Jun 10, 2018
1 parent 3115e6b commit c2e87de
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ I'm sorry, I will try my best to ease breaking changes. We're almost to 1.0, do

## [Unreleased]
### Changed
- BREAKING: pe.export: name is now optional to reflect realities of PE parsing, and add more robustness to parser. many thanks to @tathanhdinh! https://github.com/m4b/goblin/pull/88
### Added

## [0.0.15] - 2018-4-22
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,15 @@ In alphabetic order:
- [@philipc](https://github.com/philipc)
- [@rocallahan](https://github.com/rocallahan)
- [@sanxiyn](https://github.com/sanxiyn)
- [@tathanhdinh](https://github.com/tathanhdinh)
- [@ticki](https://github.com/ticki)
- [@willglynn](https://github.com/willglynn)

## Contributing

1. Please prefix commits with the affected binary component; the more specific the better, e.g., if you only modify relocations in the elf module, then do "elf.reloc: added new constants for Z80"
2. Commit messages must explain their change, no generic "changed", or "fix"; if you push commits like this on a PR, be aware @m4b or someone will most likely squash them.
3. If you are making a large change to a module, please raise an issue first and lets discuss; I don't want to waste your time if its not a good technical direction, or etc.
4. If your PR is not getting attention, please respond to all relevant comments raised on the PR, and if still no response, ping @m4b, @philipc, or @willglyn in github and also feel free to email @m4b.
5. Please add tests if you are adding a new feature. Feel free to add tests even if you are not, tests are awesome and easy in rust.
6. Once cargo format is officially released, please format your _patch_ using the default settings.

0 comments on commit c2e87de

Please sign in to comment.