diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..e7aa557 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,13 @@ +# Contributing to ARP Spoofer + +## Code of Conduct +This project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). + +## Development Process +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/amazing-feature`) +3. Write your code +4. Run tests (`pytest`) +5. Commit your changes (`git commit -m 'Add amazing feature'`) +6. Push to the branch (`git push origin feature/amazing-feature`) +7. Open a Pull Request diff --git a/docs/index.md b/docs/index.md index 0dca74e..3b86b2f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,3 +14,4 @@ ARP Spoofer is a Python-based tool that enables: - [Installation Guide](installation.md) - [Usage Guide](usage.md) - [API Reference](api.md) +- [Contributing](contributing) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 9a66304..edc2072 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,7 +21,7 @@ nav: - Installation: installation.md - Usage: usage.md - API Reference: api.md - #- Contributing: contributing.md + - Contributing: contributing.md markdown_extensions: - pymdownx.highlight