Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (43 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 1.54 KB

Contributing to Aether Pack

Thank you for your interest in contributing to Aether Pack! 🎉

We welcome all contributions, whether it's fixing bugs, adding features, improving documentation, or helping with discussions.

🚀 How to Contribute

1️⃣ Fork the Repository

  1. Click the Fork button at the top of the repository.
  2. Clone your fork:
git clone https://github.com/aether-framework/aether-pack.git
cd aether-pack

2️⃣ Create a Branch

git checkout -b feature/new-awesome-feature

Use a meaningful branch name (e.g., fix/decryption-bug or feature/new-compression-integration).

3️⃣ Implement Your Changes

  • Follow the coding style of the project.
  • Write tests if applicable (src/test/java).
  • Ensure the build is successful (mvn clean package).

4️⃣ Commit and Push

git add .
git commit -m "Added new awesome feature"
git push origin feature/new-awesome-feature

5️⃣ Open a Pull Request (PR)

  1. Go to the Pull Requests tab in the repository.
  2. Click New Pull Request.
  3. Select your branch and describe your changes.
  4. Wait for a review and feedback!

📜 Contribution Guidelines

  • ✅ Keep PRs small and focused.
  • ✅ Include clear commit messages.
  • ✅ Make sure tests pass before submitting.
  • ✅ Discuss major changes in an issue before implementation.
  • ✅ Be respectful in discussions and code reviews.

📢 Need Help?

If you have any questions, feel free to open an Issue or join our Discussions section.

🚀 Happy Coding!