Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AFLplusplus
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Ulf Kargén
AFLplusplus
Commits
0c4118ba
Commit
0c4118ba
authored
3 years ago
by
llzmb
Browse files
Options
Downloads
Patches
Plain Diff
Add info about contributing to docs
parent
6ce72deb
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+38
-2
38 additions, 2 deletions
CONTRIBUTING.md
with
38 additions
and
2 deletions
CONTRIBUTING.md
+
38
−
2
View file @
0c4118ba
# How to submit a Pull Request to AFL++
# Contributing to AFL++
## How to submit a pull request
All contributions (pull requests) must be made against our
`dev`
branch.
All contributions (pull requests) must be made against our
`dev`
branch.
...
@@ -20,4 +22,38 @@ and use AFL's macros wherever possible (e.g., WARNF, FATAL, MAP_SIZE, ...).
...
@@ -20,4 +22,38 @@ and use AFL's macros wherever possible (e.g., WARNF, FATAL, MAP_SIZE, ...).
Remember that AFL++ has to build and run on many platforms, so generalize your
Remember that AFL++ has to build and run on many platforms, so generalize your
Makefiles/GNUmakefile (or your patches to our pre-existing Makefiles) to be as
Makefiles/GNUmakefile (or your patches to our pre-existing Makefiles) to be as
generic as possible.
generic as possible.
\ No newline at end of file
## How to contribute to the docs
We welcome contributions to our docs.
Before creating a new file, please check if your content matches an existing
file in one the following folders:
*
[
docs/
](
docs/
)
(
this
is where you can find most of our docs content)
*
[
frida_mode/
](
frida_mode/
)
*
[
instrumentation/
](
instrumentation/
)
*
[
qemu_mode/
](
qemu_mode/
)
*
[
unicorn_mode/
](
unicorn_mode/
)
When working on the docs, please keep the following guidelines in mind:
*
Edit or create Markdown files and use Markdown markup.
*
Do: fuzzing_gui_program.md
*
Don't: fuzzing_gui_program.txt
*
Use underscore in file names.
*
Do: fuzzing_network_service.md
*
Don't: fuzzing-network-service.md
*
Use a maximum of 80 characters per line to make reading in a console easier.
*
Make all pull requests against
`dev`
, see
[
#how-to-submit-a-pull-request-to-afl
](
#how-to-submit-a-pull-request-to-afl
)
.
And finally, here are some best practices for writing docs content:
*
Use clear and simple language.
*
Structure your content with headings and paragraphs.
*
Use bulleted lists to present similar content in a way that makes it easy to
scan.
*
Use numbered lists for procedures or prioritizing.
*
Link to related content, for example, prerequisites or in-depth discussions.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment