Welcome, fellow space explorer! We appreciate your interest in contributing to Lunar Proxy. 🧑🚀
Your contributions will help us take a giant leap towards a more reliable and secure browsing experience.
Note: Before embarking on your mission, please review our Code of Conduct.
There are many ways you can contribute to Lunar Proxy. You can:
To ensure a smooth journey aboard our lunar mission, please follow these guidelines:
We employ a feature branch approach for development. This approach allows contributors to work on new features or bug fixes in isolated branches before merging them into the main codebase.
Every feature or bug should have a corresponding GitHub issue. Before starting work on a new feature, please check if an issue exists. If not, create a new one to track the progress.
When creating a branch for a new feature or bug fix, please use the following naming convention:
<username>.<issue#>-<description>
We have a handy script which automates the branch creation process. Feel free to use it and embark on your coding expedition:
./scripts/new_branch.shWhen you believe your code is ready for review and integration into the main codebase, open a pull request (PR) on GitHub. You can do this by running:
gh pr createWe encourage you to seek early feedback, even if your code is not yet ready to be merged. In such cases, mark the pull request as a draft to indicate its work-in-progress nature.
Once your PR has been reviewed and approved, and all continuous integration (CI) checks have successfully passed, it's time for the ultimate space maneuver: Squash and Merge. This operation combines all your commits into a single, coherent commit, preserving the integrity of our code history.
Thank you for joining us on this cosmic journey. Together, we'll propel Lunar to new heights and conquer the challenges that lie ahead. Happy coding, and may the lunar light guide your way! 🌖