Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 2.59 KB

Contributing to Cybersources

Thank you for considering contributing to Cybersources! We welcome contributions from the community to enhance the collection of tools and resources for cybersecurity professionals. Please follow the guidelines below to ensure a smooth contribution process.

  • IMPORTANT: Join the reddit community (r/cybersources) to talk about your tool!

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button on the top right of the repository page to create a copy of this repository on your GitHub account.

  2. Clone the Repository

    • Clone the forked repository to your local machine using the following command: 
      git clone https://github.com/your-username/cybersources.git

  3. Create a New Branch

    • Create a new branch for your feature or bug fix: 
      git checkout -b feature/your-feature-name

  4. Add Your Tool

    • Add your tool to the appropriate category directory in the repository. Ensure your tool includes the following:
      • Tool: The name of the tool.
      • Category: The category that best describes the tool.
      • Description: A brief description of what the tool does and how it can be used.

  5. Update the README

    • Update the README.md file to include your tool under the relevant category with a brief description and any necessary usage instructions.

  6. Commit Your Changes

    • Commit your changes with a meaningful commit message: 
      git add .
git commit -m "Add new tool: [Tool Name]"

  7. Push to Your Fork

    • Push the changes to your forked repository: 
      git push origin feature/your-feature-name

  8. Submit a Pull Request

    • Go to the original repository and click on the "Pull Requests" tab.
    • Click the "New Pull Request" button.
    • Select your forked repository and branch, then click "Create Pull Request".
    • Provide a detailed description of your changes and submit the pull request.

Contribution Guidelines

  • Quality: Ensure that your code is well-documented, formatted, and tested.
  • Relevance: Only submit tools that are relevant to the cybersecurity field.
  • Documentation: Provide clear and concise documentation for your tool, including usage instructions.
  • Respect: Be respectful and considerate in your communications with other contributors.

Contact

If you have any questions or need further assistance, feel free to open an issue in the repository, and we'll be happy to help.

Thank you for your contributions!

Created by bst04