Thank you for considering contributing to Truth-Tunnel! We’re thrilled to have you join us in making this project better. Here’s how you can get involved:
If you find a bug or have a feature request, please open an issue. When reporting issues, try to include:
- Steps to Reproduce: Clearly outline the steps to reproduce the issue.
- Expected vs. Actual Behavior: Describe what you expected to happen versus what actually happened.
- Screenshots or Code Snippets: Provide any relevant screenshots or code snippets if applicable.
We use a GitHub Flow workflow for contributions. Here’s a simple guide to get you started:
-
Fork the Repository 🍴: Click the "Fork" button at the top right of this page to create your own copy of CodeCache.
-
Clone Your Fork 🧑💻: Clone your fork to your local machine.
git clone https://github.com/MitulSonagara/truth-tunnel.git
-
Create a Branch 🌳: Create a new branch for your changes.
git checkout -b feature/<feature-name>
git checkout -b fix/<issue-number>
-
Make Changes ✏️: Make your changes in this branch. Ensure your code adheres to our coding standards and includes appropriate tests.
-
Commit Your Changes 📦: Commit your changes with a descriptive message.
git add . git commit -m "Your descriptive commit message"
-
Push Your Changes ⬆️: Push your changes to your fork on GitHub.
git push origin your-branch-name
-
Open a Pull Request 🔄: Go to the Pull Requests tab and open a new pull request from your branch. Provide a clear description of your changes.
- Follow our Coding Standards.
- Write clear, concise commit messages.
- Include tests for your changes where applicable.
- Ensure your changes are covered by existing or new tests.
Please read and follow our Code of Conduct. We strive to create a welcoming and respectful community, and we expect all contributors to adhere to our guidelines.
Thank you for contributing to Truth-Tunnel! We look forward to your contributions. 🚀