Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 2.14 KB
Raw

Contributing to Code Security

Thank you for your interest in contributing to Code Security! We appreciate your efforts to enhance software security and collaborate with the security community. This guide outlines the steps to contribute effectively.

Contribution Guidelines

Before you start contributing, please familiarize yourself with the following guidelines:

  1. Fork the Code Security repository from https://github.com/rohitcoder/code-security to your own GitHub account.

  2. Clone your forked repository to your local development environment:

    git clone https://github.com/<YOUR_USERNAME>/code-security.git

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

    Replace your-feature-name with a descriptive name for your contribution.

  4. Make your desired changes or additions to the codebase.

  5. Commit your changes with a meaningful commit message:

    git commit -m "Add your commit message here"

  6. Push your changes to your forked repository:

     ```bash
 git push origin feature/your-feature-name
 ```

  7. Open a pull request (PR) against the main repository's main branch. Ensure that you provide a clear description of your changes and any relevant information about the PR.

  8. Your PR will be reviewed by the project maintainers. Please be patient and responsive to any feedback or requests for changes.

  9. Once your changes are approved, they will be merged into the main repository. Congratulations on your contribution!

Bug Reports and Feature Requests

If you encounter any bugs or have suggestions for new features, please open an issue on the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue or a clear description of the proposed feature.

License

By contributing to the Code Security Tool, you agree that your contributions will be licensed under the MIT License.

We appreciate your time and effort in contributing to the project. Your contributions help improve the tool and make it more valuable to the community. Thank you!