-
Notifications
You must be signed in to change notification settings - Fork 382
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'refs/remotes/origin/develop' into develop
- Loading branch information
Showing
6 changed files
with
88 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,29 @@ | ||
## Pull Request Template | ||
## Description | ||
|
||
### Type of Change | ||
_Please check the relevant boxes by putting an "x" in the appropriate box._ | ||
<!-- Please provide a brief and concise description of the changes in this pull request, including the problem being solved or the feature being added. --> | ||
|
||
<!-- Please list any related issues or reference them. --> | ||
|
||
## Screenshots | ||
|
||
<!-- If applicable, please provide screenshots, video or GIF to help demonstrate the changes. --> | ||
|
||
## Type of Changes | ||
|
||
<!-- Please check the relevant boxes by putting an "x" in the appropriate box. --> | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
- [ ] This change requires a documentation update | ||
|
||
### Description | ||
_Please provide a brief and concise description of the changes in this pull request, including the problem being solved or the feature being added._ | ||
|
||
### Related Issue(s) | ||
_Please list any related issues or reference them._ | ||
## Checklist | ||
|
||
### Checklist | ||
|
||
_Please go through this checklist and make sure all applicable tasks have been done._ | ||
<!-- Please go through this checklist and make sure all applicable tasks have been done. --> | ||
|
||
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) document. | ||
- [ ] My code follows the code style of this project. | ||
- [ ] I have added tests to cover my changes. | ||
- [ ] All new and existing tests passed. | ||
- [ ] I have updated the [README.md](../README.md) as necessary if there are changes. | ||
- [ ] I have tested the changes on my local machine before submitting the PR. | ||
|
||
### Screenshots | ||
_If applicable, please provide screenshots, video or GIF to help demonstrate the changes._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,22 @@ | ||
# Contributing to Ddosify | ||
# Contributing to Anteon 🐝 | ||
|
||
Thank you for your interest in contributing to Ddosify! We appreciate the time and effort you're putting in to help improve this open-source project. In this guide, we'll provide you with the necessary information and guidelines to help you get started. | ||
Thank you for your interest in contributing to [Anteon](https://github.com/getanteon/anteon)! | ||
|
||
## 📜 Code of Conduct | ||
By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please read it carefully and ensure that your contributions and interactions with the community adhere to its principles. | ||
In this guide, we'll provide you with the necessary information and guidelines to help you get started. | ||
|
||
## 🚀 Getting Started | ||
To get started with contributing to Ddosify, follow these steps: | ||
|
||
1. Fork the [Ddosify](https://github.com/ddosify/ddosify) on GitHub. | ||
1. Fork [Anteon](https://github.com/getanteon/anteon) on GitHub. | ||
2. Clone your fork to your local machine: | ||
|
||
```bash | ||
git clone [email protected]:<YOUR_USERNAME>/ddosify.git | ||
git clone [email protected]:<YOUR_USERNAME>/anteon.git | ||
``` | ||
3. Add the Ddosify repository as an upstream remote: | ||
|
||
3. Add the Anteon repository as an upstream remote: | ||
|
||
```bash | ||
git remote add upstream https://github.com/ddosify/ddosify.git | ||
git remote add upstream https://github.com/getanteon/anteon | ||
``` | ||
|
||
4. We follow Gitflow branching model. Create a feature branch from the `develop` branch: | ||
|
@@ -26,7 +25,11 @@ git remote add upstream https://github.com/ddosify/ddosify.git | |
git checkout -b feature/FEATURE_NAME develop | ||
``` | ||
|
||
5. Set up your development environment. Go programing language (`Version >= 1.18`) is required to build and run Ddosify. You can find the installation instructions [here](https://go.dev/doc/install) for Go. We also provide [Dockerfile](./.devcontainer/Dockerfile.dev) and Visual Studio Code (VS Code) [remote container configuration](./.devcontainer/devcontainer.json) for development. More information about VS Code remote container can be found [here](https://code.visualstudio.com/docs/devcontainers/containers). | ||
5. Set up your development environment. | ||
|
||
- Go programming language (`Version >= 1.18`) is required to build and run Anteon. You can find the installation instructions [here](https://go.dev/doc/install). | ||
|
||
- We also provide [Dockerfile](./.devcontainer/Dockerfile.dev) and Visual Studio Code (VS Code) [remote container configuration](./.devcontainer/devcontainer.json) for development. More information about VS Code remote container can be found [here](https://code.visualstudio.com/docs/devcontainers/containers). | ||
|
||
6. Run the `main.go` file: | ||
|
||
|
@@ -35,7 +38,8 @@ go run main.go | |
``` | ||
|
||
## 💻 Submitting Changes | ||
Before submitting a [pull request (PR)](https://github.com/ddosify/ddosify/pulls) with your changes, please make sure you follow these guidelines: | ||
|
||
Before submitting a [pull request (PR)](https://github.com/getanteon/anteon/pulls) with your changes, please make sure you follow these guidelines: | ||
|
||
1. Ensure your code is well-formatted and follows the established coding style for this project (e.g., proper indentation, naming conventions, etc.). | ||
2. Write unit tests for any new functionality or bug fixes. Ensure that all tests pass before submitting your PR. | ||
|
@@ -45,7 +49,7 @@ Before submitting a [pull request (PR)](https://github.com/ddosify/ddosify/pulls | |
|
||
5. Add a descriptive title and detailed description to your PR, explaining the purpose and rationale behind your changes. | ||
|
||
6. Rebase your branch with the latest upstream changes before submitting your PR: | ||
6. Rebase your branch with the latest upstream changes before submitting your PR: | ||
|
||
```bash | ||
git pull --rebase upstream master | ||
|
@@ -57,27 +61,26 @@ After submitting your PR, our team will review your changes. We may ask for revi | |
|
||
## 🐛 Bug Reports | ||
|
||
We appreciate your help in identifying and fixing bugs in the Ddosify. When submitting a [bug report](https://github.com/ddosify/ddosify/issues), please include: | ||
When submitting a [bug report](https://github.com/getanteon/anteon/issues), please include: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the issue, including the steps to reproduce the bug. | ||
- Any relevant information about your environment, such as the OS, Go version, and configuration. | ||
- If possible, attach a minimal code sample or test case that demonstrates the issue. | ||
- If possible, attach a screenshot or animated GIF that demonstrates the issue. | ||
|
||
|
||
## ✨ Feature Requests | ||
We welcome suggestions for new features and improvements to the Ddosify. When submitting a [feature request](https://github.com/ddosify/ddosify/issues), please include: | ||
|
||
When submitting a [feature request](https://github.com/getanteon/anteon/issues), please include: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the proposed feature or enhancement, including the rationale behind it and any potential use cases. | ||
- If possible, provide examples or mockups to help illustrate your proposal. | ||
|
||
|
||
## 💬 Community | ||
We believe that a strong community is key to the success of the Ddosify. You can contribute to the community by: | ||
|
||
- Participating in discussions on GitHub [issues](https://github.com/ddosify/ddosify/issues) and [pull requests](https://github.com/ddosify/ddosify/pulls), providing feedback, suggestions, or sharing your experiences with the tool. | ||
- Promoting the Ddosify by writing blog posts, creating video tutorials, or sharing the project on social media. | ||
Join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else. We're happy to help you out! | ||
|
||
You can join our [Discord Server](https://discord.com/invite/9KdnrSUZQg) for issues, feature requests, feedbacks or anything else. We're happy to help you out! | ||
## 📜 Code of Conduct | ||
|
||
By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please read it carefully and ensure that your contributions and interactions with the community adhere to its principles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,36 @@ | ||
# Ddosify Security Policy | ||
# Anteon Security Policy 🐝 | ||
|
||
We are committed to maintaining the security and integrity of the Ddosify, and we appreciate your help in identifying and addressing potential vulnerabilities. This document outlines the process for reporting security issues, as well as our commitment to addressing them in a timely manner. | ||
We are committed to maintaining the security and integrity of [Anteon](https://github.com/getanteon/anteon), and we appreciate your help in identifying and addressing potential vulnerabilities. | ||
|
||
This document outlines the process for reporting security issues, as well as our commitment to addressing them in a timely manner. | ||
|
||
## Supported Versions | ||
|
||
We provide security updates for the following version of the Ddosify: | ||
We provide security updates for the following versions: | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| > `0.15.x` | ✅ | | ||
| Version | Supported | | ||
| ---------- | --------- | | ||
| > `0.15.x` | ✅ | | ||
|
||
⚠️ Please note that older versions may not receive security updates. We encourage you to use the [latest version](https://github.com/ddosify/ddosify/releases) of the software to benefit from the most recent security enhancements. | ||
⚠️ Please note that older versions may not receive security updates. We encourage you to use the [latest version](https://github.com/getanteon/anteon/releases) of the software to benefit from the most recent security enhancements. | ||
|
||
## Reporting a Vulnerability | ||
If you believe you have discovered a security vulnerability in the Ddosify, please follow these steps to report it: | ||
|
||
If you believe you have discovered a security vulnerability, please follow these steps to report it: | ||
|
||
1. Do not create a public issue on GitHub. Disclosing security vulnerabilities publicly can put users at risk. | ||
2. Send an email to our security team at security@ddosify.com with a detailed description of the vulnerability, including the steps to reproduce it, and any relevant information about your environment (e.g., OS, Go version, etc.). | ||
2. Send an email to our security team at security@getanteon.com with a detailed description of the vulnerability, including the steps to reproduce it, and any relevant information about your environment (e.g., OS, Go version, etc.). | ||
3. If possible, provide a minimal code sample or test case that demonstrates the vulnerability. | ||
4. Allow us a reasonable amount of time to investigate and address the issue before publicly disclosing it. We will make every effort to resolve the issue as soon as possible. | ||
|
||
We keep you informed of our progress in addressing the issue. | ||
|
||
## Our Commitment | ||
|
||
We take security issues very seriously and are committed to working with you to address any vulnerabilities that you report. We will: | ||
|
||
- Investigate and validate reported vulnerabilities. | ||
- Work on a fix or mitigation for the issue. | ||
- Provide regular updates on our progress in resolving the issue. | ||
- Notify you when the issue has been resolved and provide details on the changes made. | ||
- We appreciate your assistance in maintaining the security of Ddosify, and we thank you for your responsible disclosure. | ||
- We appreciate your assistance in maintaining the security of Anteon, and we thank you for your responsible disclosure. |