Skip to content

Latest commit

 

History

History
86 lines (53 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

86 lines (53 loc) · 3.63 KB
Raw

Contributing to Anteon 🐝

Thank you for your interest in contributing to Anteon!

In this guide, we'll provide you with the necessary information and guidelines to help you get started.

🚀 Getting Started

  1. Fork Anteon on GitHub.
  2. Clone your fork to your local machine:
git clone [email protected]:<YOUR_USERNAME>/anteon.git
  1. Add the Anteon repository as an upstream remote:
git remote add upstream https://github.com/getanteon/anteon
  1. We follow Gitflow branching model. Create a feature branch from the develop branch:
git checkout -b feature/FEATURE_NAME develop
  1. 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.

  • We also provide Dockerfile and Visual Studio Code (VS Code) remote container configuration for development. More information about VS Code remote container can be found here.

  1. Run the main.go file:
go run main.go

💻 Submitting Changes

Before submitting a pull request (PR) 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.

  3. Update the README.md file according to your changes.

  4. Keep your PRs focused and as small as possible. If you have multiple unrelated changes, create separate PRs for them.

  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:

git pull --rebase upstream master
  1. Create a pull request (PR) against the develop branch.

After submitting your PR, our team will review your changes. We may ask for revisions or provide feedback before merging your changes into the master branch. Your patience and cooperation are greatly appreciated.

🐛 Bug Reports

When submitting a bug report, 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

When submitting a feature request, 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

Join our Discord Server 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. Please read it carefully and ensure that your contributions and interactions with the community adhere to its principles.