Skip to content

Latest commit

 

History

History
182 lines (116 loc) · 7.42 KB

CONTRIBUTING.md

File metadata and controls

182 lines (116 loc) · 7.42 KB
Raw

Contributing to Hack-Academia

"A real community exists only when its members interact in a meaningful way that deepens their understanding of each other and leads to learning."

Thank you for considering contributing to Hack-Academia! This repository is a comprehensive collection of cybersecurity resources aimed at helping enthusiasts and professionals alike. Here’s how you can contribute:

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct to maintain a respectful and inclusive community.

Using the Issue Tracker

The issue tracker is the preferred channel for reporting bugs, requesting new features, and submitting pull requests. Please adhere to the following guidelines:

  • No personal support requests: Use Stack Overflow or relevant forums for personal support.
  • Stay on topic: Keep discussions focused and respect other contributors' opinions.

Contributing to the Repository

Reporting Issues

If you find any bugs or have suggestions, please create an issue using the provided templates. Clearly describe the problem, steps to reproduce, and any other relevant information.

Submitting Enhancements

  1. Create an Issue: Describe your enhancement or new resource suggestion.
  2. Fork the Repository: Make a copy of this repository to your GitHub account.
  3. Make Changes: Push your code to your fork.
  4. Open a Pull Request: Submit your changes for review.
  5. Review and Merge: After a thorough review, your changes will be merged.
  6. Credit: Update the issue to ensure you receive proper credit in the README.

Pull Requests

When creating a pull request, please:

  • Base your code on the latest master branch to avoid conflicts.
  • Be open to feedback and code reviews.
  • Clearly explain the problem and your proposed solution.
  • Provide a concise, one-line description without line breaks.

Finding and Fixing Broken Links

Here's a script to find broken links in the repository:

git clone https://github.com/your-username/Hack-Academia && cd Hack-Academia

for i in $(sed -n 's/.*href="\([^"]*\).*/\1/p' README.md | grep -v "^#") ; do
  _rcode=$(curl -s -o /dev/null -w "%{http_code}" "$i")
  if [[ "$_rcode" != "2"* ]] ; then echo " -> $i - $_rcode" ; fi
done

Signature of Commit

All commits must include a "signed-off-by" line indicating the name and email address of the contributor. To enable this, add the following lines to .git/hooks/prepare-commit-msg:

SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p')
grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

Community Guidelines

  • Respect: Be patient and respectful towards all contributors.
  • Ethical Hacking Only: We focus on ethical hacking. Malicious tools or discussions are not allowed.
  • Verified Tools Only: Ensure any tools you submit are well-maintained and have a good community backing.
  • Educational Focus: Contributions should aim to educate and help others learn about cybersecurity.

Style Guide for Contributions

  • Code Style: Follow the existing code style and conventions in the project.
  • Documentation: Update documentation with any changes to ensure it's always current.
  • Commit Messages: Write clear, descriptive commit messages.

Testing Your Changes

Before submitting a pull request, make sure your changes pass all tests:

  1. Unit Tests: Ensure your code passes existing unit tests.
  2. New Tests: Write new tests for any new functionality.

Getting Help

If you need any help or have questions, feel free to open an issue or join our community discussions.

License

By contributing, you agree that your contributions will be licensed under the same license as the project. Please read the LICENSE file for more details.

Thank you for contributing to Hack-Academia! Together, we can create a valuable resource for the cybersecurity community. 🎉