Skip to content

Commit

Permalink
1.0.73 Update Github files
Browse files Browse the repository at this point in the history
  • Loading branch information
webpwnized committed Oct 20, 2024
1 parent 981492e commit 0608064
Show file tree
Hide file tree
Showing 3 changed files with 154 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# **CHANGELOG**

All notable changes to this project are automatically tracked in the **GitHub repository**.
You can view the full history of changes, including commits, pull requests, and releases, directly in the repository.

## **How to View Changes:**
1. **Commits:**
- View individual commits that reflect each change:
[Commits History](https://github.com/webpwnized/mutillidae-docker/commits/main)

2. **Pull Requests:**
- Review discussions and changes introduced through pull requests:
[Pull Requests](https://github.com/webpwnized/mutillidae-docker/pulls)

3. **Releases:**
- Check tagged releases with detailed descriptions:
[Releases](https://github.com/webpwnized/mutillidae-docker/releases)

## **Note:**
This project follows a **Git-based change tracking approach**, where all modifications are captured in:
- **Commit messages**
- **Pull request descriptions**
- **Release notes**

To stay updated, make sure to:
- **Watch the repository** for new releases and changes.
- **Subscribe to the releases feed** for the latest updates.
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@

# **Contributing to Mutillidae-Docker**

We welcome contributions to **Mutillidae-Docker**! To ensure a smooth collaboration, please follow the steps outlined below for submitting changes via **feature branches**.

---

## **Getting Started**
1. **Fork the Repository:**
- Click the **Fork** button at the top-right corner of the [Mutillidae-Docker GitHub repository](https://github.com/webpwnized/mutillidae-docker).

2. **Clone Your Fork:**
```bash
git clone https://github.com/<your-username>/mutillidae-docker.git
cd mutillidae-docker
```

3. **Set the Original Repository as Upstream:**
- Add the upstream repository to stay in sync with the main project:
```bash
git remote add upstream https://github.com/webpwnized/mutillidae-docker.git
```

---

## **Creating a Feature Branch**
1. **Create a New Branch for Your Changes:**
- Use a descriptive branch name that reflects the feature or issue being worked on:
```bash
git checkout -b feature/your-feature-name
```

2. **Make Your Changes:**
- Add, modify, or remove files as needed.

3. **Commit Your Changes:**
- Write meaningful commit messages:
```bash
git add .
git commit -m "feat: Brief description of the changes"
```

---

## **Sync with the Upstream Repository**
Before submitting your changes, make sure your feature branch is up-to-date with the latest code from the main repository.

1. **Fetch and Merge Changes from Upstream:**
```bash
git fetch upstream
git merge upstream/main
```

2. **Resolve Any Merge Conflicts (if needed):**
- If conflicts arise, carefully resolve them before proceeding.

---

## **Push and Submit a Pull Request**
1. **Push Your Feature Branch to Your Fork:**
```bash
git push origin feature/your-feature-name
```

2. **Open a Pull Request:**
- Go to the [Mutillidae-Docker repository](https://github.com/webpwnized/mutillidae-docker) and click on **New Pull Request**.
- Select your feature branch and submit the pull request with a clear title and description.

---

## **PR Review and Feedback**
- A project maintainer will review your pull request. Be prepared to make changes if feedback is provided.
- Once your pull request is approved, it will be merged into the main repository.

---

## **Guidelines for Contributors**
- Follow the **feature branch** GitOps model: each feature or bug fix should have its own branch.
- Use meaningful commit messages following the **conventional commits** style (`feat:`, `fix:`, `docs:`, etc.).
- Ensure your changes do not break existing functionality by running tests (if applicable).
- Keep your pull requests small and focused on a single issue or feature to make reviews easier.

---

Thank you for your contribution! Together, we can make **Mutillidae-Docker** even better.

41 changes: 41 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

# **Security Policy for Mutillidae-Docker**

Mutillidae-Docker is a project that helps deploy and manage the **Mutillidae cybersecurity training platform** using Docker. Below is our security policy to ensure that any issues are handled promptly and transparently.

---

## **Reporting Security Issues**

If you discover a security vulnerability in **Mutillidae-Docker**, please follow these steps:

1. **Open an Issue**:
- Go to the [Issues section of the Mutillidae-Docker repository](https://github.com/webpwnized/mutillidae-docker/issues).
- Create a new issue with:
- A detailed description of the vulnerability.
- Steps to reproduce the issue.
- The potential impact or risk of the vulnerability.

---

## **Security Expectations**

Since this project is primarily used to deploy the **Mutillidae** platform, please keep in mind:

- **Intentional Vulnerabilities in Mutillidae**:
- Mutillidae is a deliberately vulnerable application meant for cybersecurity training.
- If the reported issue pertains to **vulnerabilities within the Mutillidae platform itself**, it may not be treated as a security issue unless it affects the **deployment process** or the **Docker configuration**.

- **Mutillidae-Docker Configuration**:
- Vulnerabilities related to the Docker setup, image security, exposed ports, or misconfigurations will be treated as valid security concerns.

---

## **Responsible Disclosure**

We encourage responsible disclosure and appreciate contributions from the security community. All reported issues will be evaluated promptly, and necessary actions will be taken to address confirmed vulnerabilities.

---

Thank you for helping us ensure the security of **Mutillidae-Docker**.

0 comments on commit 0608064

Please sign in to comment.