Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (43 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 2.68 KB

Contributing to CodeCache 🎉

Thank you for considering contributing to CodeCache! We’re thrilled to have you join us in making this project better. Here’s how you can get involved:

How to Contribute 🤝

Reporting Issues 🐞

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.

Submitting Code 💻

We use a GitHub Flow workflow for contributions. Here’s a simple guide to get you started:

  1. Fork the Repository 🍴: Click the "Fork" button at the top right of this page to create your own copy of CodeCache.

  2. Clone Your Fork 🧑‍💻: Clone your fork to your local machine.

    git clone https://github.com/notsoocool/codecache.git

  3. Create a Branch 🌳: Create a new branch for your changes.

    git checkout -b feature/<feature-name>
    git checkout -b fix/<issue-number>

  4. Make Changes ✏️: Make your changes in this branch. Ensure your code adheres to our coding standards and includes appropriate tests.

  5. Commit Your Changes 📦: Commit your changes with a descriptive message.

    git add .
git commit -m "Your descriptive commit message"

  6. Push Your Changes ⬆️: Push your changes to your fork on GitHub.

    git push origin your-branch-name

  7. 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.

Important Note:

Kindly push changes from the develop branch only and always push to the develop branch. This ensures we maintain a stable master branch and test all changes thoroughly before merging them into the main codebase.

Coding Guidelines 📜

  • 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.

Code of Conduct 🌟

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 CodeCache! We look forward to your contributions. 🚀