Chat with BLT Bot

We reply immediately

Loading...

Contribute to OWASP BLT

OWASP BLT thrives on the contributions of its community. Whether you're a developer, security researcher, designer, or just passionate about making the web a safer place, there are many ways you can contribute to the BLT project.

Ways to Contribute

  • Code Contributions: Help us develop new features, fix bugs, or improve existing code. Check out our GitHub repository to see open issues and start contributing.
  • Report Bugs: Found a bug? Report it through the Bug Reporting Tool. Your input helps us improve the platform.
  • Documentation: Contribute to our documentation by improving the existing guides or writing new ones. Great documentation helps everyone understand and use BLT more effectively.
  • Design and UX: If you have skills in design or user experience, you can help make BLT more user-friendly and visually appealing.
  • Security Research: Perform security testing and contribute to making BLT more secure. You can also participate in private bug bounties for specific security challenges.
  • Community Engagement: Engage with the community by answering questions, providing feedback, and sharing your knowledge on our OWASP BLT Wiki and forums.

Getting Started

Ready to start contributing? Here are a few steps to get you going:

  1. Join the Community: Sign up on the OWASP forums and join the conversation.
  2. Clone the Repository: Clone the BLT repository from GitHub to your local machine.
  3. Pick an Issue: Browse the open issues and pick one that matches your skills and interests.
  4. Start Coding: Fork the repository, create a new branch, and start working on your issue.
  5. Submit a Pull Request: Once you're done, submit a pull request and our maintainers will review it.

Getting Involved

You don't have to be a security expert or programmer to contribute! All types of contributions are welcome.

Good First Issues

New contributors can start with issues tagged as "good first issue" on our GitHub repository. These are specifically selected to help newcomers get started.

How to Take an Issue

  • Find an issue you'd like to work on
  • Use the "Create a branch" button on the right of the issue to link your contribution
  • Comment "assign to me" or type "/assign" to take ownership of the issue

Community Support

Join our community on the OWASP Slack Channel in the #project-blt channel to:

  • Ask questions and get help
  • Connect with other contributors
  • Stay updated on project developments
  • Share your ideas and feedback

Coding Style Guide

Please follow the black code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. Use pre-commit run command to make sure your changes comply with the standards.

Development

Make sure to run pre-commit before committing so it formats the code.

Setting Up Development Server

Please follow the development server setup procedure here. Currently, development server can be installed using Docker or Vagrant. You can also use virtualenv or pipenv install, pipenv shell, and then continue with the remaining instructions.

Documentation

  • Use the Installation Docs to get started.
  • Swagger API Documentations can be found at the root domain /swagger/.
  • Postman API Documentations: Postman Docs.
v1.5