Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

89 lines (60 loc) · 2.48 KB
Raw

Contributing to ThreatSleuth

Thank you for your interest in contributing to ThreatSleuth! We welcome contributions to help improve and expand the platform. Whether you're fixing bugs, building new features, writing documentation, or testing, your efforts are greatly appreciated.

How to Contribute

1. Fork the Repository

  1. Go to the _ThreatSleuth repository.
  2. Click the Fork button at the top-right corner of the page to create a copy of the repository under your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine using the following command:

git clone https://github.com/sanjayh-2022/_ThreatSleuth
cd _ThreatSleuth

3. Create a New Branch

Create a new branch for your contribution:

git checkout -b feature/your-feature-name

4. Make Changes

Make your desired changes to the codebase. Please ensure that your changes:

  • Follow the existing code style and conventions
  • Include appropriate tests
  • Update documentation as needed

For information about building and setting up the development environment, please refer to our README.md file.

5. Commit Your Changes

Commit your changes with a clear and descriptive commit message:

git add .
git commit -m "feat: Add new feature" # Use conventional commit messages

6. Push Changes

Push your changes to your forked repository:

git push origin feature/your-feature-name

7. Create a Pull Request

  1. Go to the original ThreatSleuth repository
  2. Click on "Pull Requests"
  3. Click the "New Pull Request" button
  4. Select your fork and branch
  5. Fill out the PR template with all relevant information
  6. Submit the pull request

Development Guidelines

  • Follow the coding style and conventions used throughout the project
  • Write clear, descriptive commit messages following conventional commits
  • Update documentation for any changed functionality
  • Ensure all tests pass before submitting a pull request

Code Review Process

  • All submissions require review before being merged
  • Maintainers will review your code for:
    • Functionality
    • Code style
    • Test coverage
    • Documentation
  • Address any feedback or requested changes promptly

Getting Help

If you need help or have questions:

  • Open an issue for bug reports or feature requests
  • Check our documentation for more information

License

By contributing to ThreatSleuth, you agree that your contributions will be licensed under the same terms as the project.