Thank you for considering contributing to our project! Here are some guidelines to help you get started and ensure a smooth contribution process.
- Fork and Code
- Begin by forking the repository.
- Write your code within your forked repository.
- Pull Request
- Once your contribution is ready, create a Pull Request (PR) to the dev branch of the main repository.
- Provide a clear and concise description of your changes in the PR.
- Completion
- That's it! You're done. Await feedback and further instructions from the maintainers.
graph TD
subgraph Forked Branches
fork1["forked branch 1"]
fork2["forked branch 2"]
fork3["forked branch 3"]
end
fork1 --> dev["dev branch"]
fork2 --> dev
fork3 --> dev
dev --> main["main branch"]
dev --> deployments["documentation deployments (https://owasp-noir.github.io)"]
main -->|release| homebrew["homebrew"]
main -->|release| snapcraft["snapcraft"]
main -->|release| docker["docker (ghcr)"]
# If you've forked this repository, clone to https://github.com/<YOU>/noir
git clone https://github.com/hahwul/noir
cd noir
shards install
shards build
# ./bin/noir
crystal spec
# If you want more detail?
crystal spec -v
crystal tool format
ameba --fix
# Ameba installation
# https://github.com/crystal-ameba/ameba#installation
- spec:
- unit_test: Unit test codes. (for
crystal spec
command) - functional_test: Functional test codes.
- unit_test: Unit test codes. (for
- src: Contains the source code.
- analyzer: Code analyzers for Endpoint URL and Parameter analysis.
- detector: Codes for language and framework identification.
- models: Contains everything related to models, such as classes and structures.
- noir.cr: Main file and command-line parser.
Feel free to reach out to us if you have any questions or need further assistance!
Please note that our web page operates based on the dev branch. If you make any changes, kindly send a Pull Request (PR) to the dev branch.
To ensure a smooth integration of your contributions, please follow these steps:
- Fork the repository and create your feature branch from dev.
- Make your changes, ensuring they are thoroughly tested.
- Submit your PR to the dev branch for review.
By doing so, you'll help us keep our project up-to-date and well-organized. Your efforts are greatly appreciated, and we're excited to see what you'll bring to the project!