Skip to content

Commit

Permalink
chore: Update contributing guidelines and documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hahwul committed Jul 10, 2024
1 parent 7302242 commit 1c42f79
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,16 @@ ameba --fix
- 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!
Feel free to reach out to us if you have any questions or need further assistance!

## Documents contributing

Please note that [our web page](https://owasp-noir.github.io/noir/) 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!
12 changes: 11 additions & 1 deletion docs/introdution.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,14 @@ flowchart LR
Analyzers --> OutputBuilder
OutputBuilder --> Endpoints
```
```

## How to contribute?

Open-source projects thrive on the strength of the community. From small contributions to major ones, we want to express our gratitude to all contributors. If you're interested in contributing, please check out this document.

We believe every contribution counts and appreciate the time and effort you put into making this project better. Whether you're fixing a typo, adding a new feature, or improving documentation, your help is invaluable. Thank you for being part of our community!

To get started, simply follow the guidelines in the [Contribute Guide](https://github.com/owasp-noir/noir/blob/main/CONTRIBUTING.md). It's full of helpful tips and instructions to make your first contribution smooth and enjoyable.

Happy contributing!

0 comments on commit 1c42f79

Please sign in to comment.