Thank you for your interest in contributing to Cryptora! I strive to make the process of contributing as simple and clear as possible.
-
Familiarize Yourself with the Project
- Read the README.md to understand the project's goals and features.
- Ensure all required dependencies are installed as described in the "Installation Guide" section.
-
Check Existing Issues
- Visit the Issues section of the project.
- If you encounter a problem or have an idea for improvement, feel free to create a new issue.
If you discover an issue, please follow these steps:
- Ensure the issue hasn’t already been reported by checking existing issues.
- Create a new issue and include the following details:
- Brief description of the problem.
- Steps to reproduce (so the issue can be replicated).
- Expected behavior (what should happen instead).
- Environment details:
- Java Version:
- Gradle Version:
- Docker Version:
- OS:
- Logs or screenshots that help clarify the problem.
If you have an idea for a new feature:
- Check if a similar feature request already exists.
- Create a new issue and include:
- Feature description (what you want to achieve).
- Why it’s important (how it improves the project or solves a problem).
- Suggested implementation (ideas for how it could be implemented).
- Additional context (any extra information that could help).
-
Fork the Repository
git fork https://github.com/dzenthai/cryptora.git cd cryptora -
Create a New Branch for Your Changes
git checkout -b feature/your-feature-name
-
Make Changes to the Code
- Ensure your code follows the project's style.
- Add tests if necessary.
-
Test the Project Before Submitting
./gradlew build
-
Commit Your Changes
git commit -m "Add feature X to improve functionality Y" -
Push Your Changes
git push origin feature/your-feature-name
-
Create a Pull Request
- Go to the original repository and create a pull request, detailing the changes you’ve made.