Skip to content

Commit

Permalink
Enhance contribute.html with improved styling and accessibility features
Browse files Browse the repository at this point in the history
  • Loading branch information
@DonnieBLT
DonnieBLT committed Nov 11, 2024
1 parent 59de76a commit e656d45
Showing 1 changed file with 51 additions and 38 deletions.
89 changes: 51 additions & 38 deletions website/templates/contribute.html
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
{% extends "base.html" %}
{% block content %}
<div class="container">
<div class="container mx-auto px-4">
<!-- Include the left navigation -->
{% include "includes/sidenav.html" %}
<!-- Main Content Section -->
<div class="main-content">
<section id="contribute-overview">
<h2>Contribute to OWASP BLT</h2>
<p>
<div class="max-w-8xl mx-auto">
<section id="contribute-overview" class="text-center my-8">
<h2 class="text-3xl font-bold mb-4">Contribute to OWASP BLT</h2>
<p class="text-lg">
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.
</p>
</section>
<section id="ways-to-contribute">
<h3>Ways to Contribute</h3>
<ul>
<section id="ways-to-contribute" class="my-8">
<h3 class="text-2xl font-semibold mb-4">Ways to Contribute</h3>
<ul class="list-disc list-inside space-y-4">
<li>
<strong>Code Contributions:</strong> Help us develop new features, fix bugs, or improve existing code. Check out our <a href="https://github.com/owasp/blt" target="_blank">GitHub repository</a> to see open issues and start contributing.
<strong>Code Contributions:</strong> Help us develop new features, fix bugs, or improve existing code. Check out our <a href="https://github.com/owasp/blt"
target="_blank"
class="text-blue-500 hover:underline">GitHub repository</a> to see open issues and start contributing.
</li>
<li>
<strong>Report Bugs:</strong> Found a bug? Report it through the <a href="{% url 'issues' %}">Bug Reporting Tool</a>. Your input helps us improve the platform.
<strong>Report Bugs:</strong> Found a bug? Report it through the <a href="{% url 'issues' %}" class="text-blue-500 hover:underline">Bug Reporting Tool</a>. Your input helps us improve the platform.
</li>
<li>
<strong>Documentation:</strong> Contribute to our documentation by improving the existing guides or writing new ones. Great documentation helps everyone understand and use BLT more effectively.
Expand All @@ -27,26 +29,29 @@ <h3>Ways to Contribute</h3>
<strong>Design and UX:</strong> If you have skills in design or user experience, you can help make BLT more user-friendly and visually appealing.
</li>
<li>
<strong>Security Research:</strong> Perform security testing and contribute to making BLT more secure. You can also participate in <a href="{% url 'issues' %}">private bug bounties</a> for specific security challenges.
<strong>Security Research:</strong> Perform security testing and contribute to making BLT more secure. You can also participate in <a href="{% url 'issues' %}" class="text-blue-500 hover:underline">private bug bounties</a> for specific security challenges.
</li>
<li>
<strong>Community Engagement:</strong> Engage with the community by answering questions, providing feedback, and sharing your knowledge on our <a href="https://owasp.org/www-project-bug-logging-tool/"
target="_blank">OWASP BLT Wiki</a> and forums.
target="_blank"
class="text-blue-500 hover:underline">OWASP BLT Wiki</a> and forums.
</li>
</ul>
</section>
<section id="getting-started">
<h3>Getting Started</h3>
<p>Ready to start contributing? Here are a few steps to get you going:</p>
<ol>
<section id="getting-started" class="my-8">
<h3 class="text-2xl font-semibold mb-4">Getting Started</h3>
<p class="mb-4">Ready to start contributing? Here are a few steps to get you going:</p>
<ol class="list-decimal list-inside space-y-2">
<li>
<strong>Join the Community:</strong> Sign up on the OWASP forums and join the conversation.
</li>
<li>
<strong>Clone the Repository:</strong> Clone the BLT repository from GitHub to your local machine.
</li>
<li>
<strong>Pick an Issue:</strong> Browse the <a href="https://github.com/owasp/blt/issues" target="_blank">open issues</a> and pick one that matches your skills and interests.
<strong>Pick an Issue:</strong> Browse the <a href="https://github.com/owasp/blt/issues"
target="_blank"
class="text-blue-500 hover:underline">open issues</a> and pick one that matches your skills and interests.
</li>
<li>
<strong>Start Coding:</strong> Fork the repository, create a new branch, and start working on your issue.
Expand All @@ -56,58 +61,66 @@ <h3>Getting Started</h3>
</li>
</ol>
</section>
<section id="contact">
<h3>Coding Style Guide</h3>
<p>
Please follow the <a href="https://github.com/psf/black" target="_blank">black</a> code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. Use <code>pre-commit run</code> command to make sure your changes comply with the standards.
<section id="contact" class="my-8">
<h3 class="text-2xl font-semibold mb-4">Coding Style Guide</h3>
<p class="mb-4">
Please follow the <a href="https://github.com/psf/black"
target="_blank"
class="text-blue-500 hover:underline">black</a> code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. Use <code class="bg-gray-100 p-1 rounded">pre-commit run</code> command to make sure your changes comply with the standards.
</p>
<ul>
<ul class="list-disc list-inside space-y-2">
<li>To take a GitHub issue, type a comment that says 'assign to me' or '/assign,' and it will be assigned to you.</li>
<li>
<strong>Figma Designs:</strong>
<ul>
<ul class="list-disc list-inside ml-6 space-y-1">
<li>
<a href="https://www.figma.com/file/JE0QlQ95FVpk0wG9HyFw4D/BLT-Website?type=design&node-id=0%3A1&t=9aPMxdjUDBIUirAz-1"
target="_blank">New Tailwind Website Designs</a>
target="_blank"
class="text-blue-500 hover:underline">New Tailwind Website Designs</a>
</li>
<li>
<a href="https://www.figma.com/file/NYD5WZzJywnO338lchnece/Bug-Logging-Tool?type=design&node-id=0%3A1&t=k0Hx6qW4Ue9iZvbH-1"
target="_blank">New Mobile Designs</a>
target="_blank"
class="text-blue-500 hover:underline">New Mobile Designs</a>
</li>
<li>
<a href="https://www.figma.com/file/s0xuxeU6O2guoWEfA9OElZ/Design"
target="_blank">Old Website and Mobile Designs</a>
target="_blank"
class="text-blue-500 hover:underline">Old Website and Mobile Designs</a>
</li>
</ul>
</li>
<li>
Github activity can be seen in Slack <strong>#blt-github</strong>.
</li>
<li>
Communicate with us on slack <strong>#project-blt</strong> <a href="#" target="_blank">Join OWASP Slack Channel</a>
Communicate with us on slack <strong>#project-blt</strong> <a href="#" target="_blank" class="text-blue-500 hover:underline">Join OWASP Slack Channel</a>
</li>
</ul>
<h3>Development</h3>
<p>
Make sure to run <code>pre-commit</code> before committing so it formats the code.
<h3 class="text-2xl font-semibold mt-8 mb-4">Development</h3>
<p class="mb-4">
Make sure to run <code class="bg-gray-100 p-1 rounded">pre-commit</code> before committing so it formats the code.
</p>
<h4>Setting Up Development Server</h4>
<p>
<h4 class="text-xl font-semibold mb-2">Setting Up Development Server</h4>
<p class="mb-4">
Please follow the development server setup procedure <a href="https://github.com/OWASP/BLT/blob/main/Setup.md"
target="_blank">here</a>. 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.
target="_blank"
class="text-blue-500 hover:underline">here</a>. 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.
</p>
<h4>Documentation</h4>
<ul>
<h4 class="text-xl font-semibold mb-2">Documentation</h4>
<ul class="list-disc list-inside space-y-2">
<li>
Use the <a href="https://github.com/OWASP/BLT/blob/main/Setup.md"
target="_blank">Installation Docs</a> to get started.
target="_blank"
class="text-blue-500 hover:underline">Installation Docs</a> to get started.
</li>
<li>
Swagger API Documentations can be found at the root domain <code>/swagger/</code>.
Swagger API Documentations can be found at the root domain <code class="bg-gray-100 p-1 rounded">/swagger/</code>.
</li>
<li>
Postman API Documentations: <a href="https://documenter.getpostman.com/view/19782933/VUqpscyV"
target="_blank">Postman Docs</a>.
target="_blank"
class="text-blue-500 hover:underline">Postman Docs</a>.
</li>
</ul>
</section>
Expand Down

0 comments on commit e656d45

Please sign in to comment.