From fd571b0aeffb313adabe658707ef6d7015def16b Mon Sep 17 00:00:00 2001 From: Grant Hernandez Date: Mon, 25 Oct 2021 11:20:25 -0400 Subject: [PATCH] Public release Signed-off-by: Grant Hernandez --- .github/CONTRIBUTING.md | 27 +++++++++++++++ CODE-OF-CONDUCT.md | 73 +++++++++++++++++++++++++++++++++++++++++ README.md | 3 ++ 3 files changed, 103 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 CODE-OF-CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6194cb8 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## Contributing to AFLTriage + +AFLTriage is for the community and contributions are welcome. + +## Submitting a Pull Request + +1. Please read the [code of conduct](../CODE-OF-CONDUCT.md) and [license](../LICENSE). All code you contribute must be brand new and not previously covered by any other license. +1. Fork the repository on GitHub and clone your fork to your local machine. +1. Create a new branch based on `main`: `git checkout -b main`. +1. Make your changes, add tests, and make sure all tests still pass. +1. Commit your changes using the [DCO](http://developercertificate.org/). You can attest to the DCO by commiting with the **-s** or **--signoff** options to `git commit` or manually adding the "Signed-off-by: " to the commit message. +1. Push to your fork and submit a pull request from your branch to `main`. + +Here are a few things you can do that will increase the likelihood your pull request will be accepted: + +- Follow the existing codestyle where possible. Use rustfmt and optionally Clippy and/or rust-analyzer +- Write tests when applicable. Untested code is likely to break +- Make sure your PR is a singled focused commit OR contains multiple minimized commits +- Larger changes MUST reference an issue. It's best to discuss the approach *before* writing code. Otherwise there is a risk that the code will not meet the project standards. WIP PRs are acceptable, but should reference an accompanying issue. + +## Contributions to Avoid + +While contributions are welcome, some are unlikely to be accepted. Here is a non-exhaustive list: + +* Changes that introduce a large maintenance burden. This includes features that cannot be automatically tested via continuous integration or project maintainers (e.g. exotic platforms, architectures, or debuggers) +* Changes that affect the usability of AFLTriage (e.g. new required command lines, run-time dependencies) +* Changes that require a significant rearchitecture of the project. Open an issue instead diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..7ef343f --- /dev/null +++ b/CODE-OF-CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team. All complaints will be reviewed +and investigated and will result in a response that is deemed necessary and +appropriate to the circumstances. The project team is obligated to maintain +confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/README.md b/README.md index de2ea88..abb3625 100644 --- a/README.md +++ b/README.md @@ -117,3 +117,6 @@ ARGS: * [GDB Exploitable](https://github.com/jfoote/exploitable) - A big inspiration for AFLTriage * [Crashwalk](https://github.com/bnagy/crashwalk) * afl-collect from [afl-utils](https://github.com/rc0r/afl-utils) + +## License +AFLTriage is licensed under the BSD 3-clause "New" or "Revised". See [LICENSE](LICENSE) for more details.