Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 2.64 KB
Raw

🌟 Contributing to Gyanchakkhu

Thank you for your interest in contributing to Gyanchakkhu! We’re thrilled to have you here and can’t wait to see your amazing contributions. Follow this beginner-friendly guide to get started and make your mark on the project. 🚀

🚀 How to Contribute?

1. Star and Fork the Repository

  • Hit the ⭐ Star button on this repository to show your support.
  • Fork the repository to your GitHub account. This lets you work on a copy of the project independently.

2. Clone the Repository

Once you’ve forked the repo, clone it to your computer to start working:

git clone https://github.com/<your-username>/Gyanchakkhu-admin.git

Replace <your-username> with your GitHub username.

3. Create a New Branch

To keep your changes organized, create a new branch:

git checkout -b <your-branch-name>

Use a meaningful branch name, like your name or the feature you're working on (e.g., john-add-navbar).

4. Make Changes

  • Add your files, modify existing ones, or implement a new feature.
  • Be creative and ensure your code follows the project’s style and conventions.

5. Commit Your Changes

Save your work with a clear, descriptive commit message:

git commit -m "Added a new feature to improve user experience"

6. Push Your Changes

Push the changes you made in your branch to your forked repository:

git push origin <your-branch-name>

7. Create a Pull Request (PR)

Now it’s time to submit your work:

  • Visit the original repository on GitHub.
  • Click the Pull Requests tab and then New Pull Request.
  • Choose your branch and fill in the PR details:
    • Mention the issue(if applicable) your changes address (e.g., Fixes #123).
    • Clearly explain what you did and why it’s important.

🛠 Additional Guidelines

  • Follow the Code Style: Stick to the existing coding standards for consistency.
  • Add Documentation: Update the README or related files if you’re adding new features.
  • Write Tests: If applicable, include tests to ensure your changes work as intended.
  • Link Issues: Mention issues in your PR using Fixes #issue-number to auto-close them upon merge.

💡 Need Help?

If you’re stuck or need help, feel free to:

  • Open a new issue with your query.
  • Join or open a discussion in our project forums.
  • Tag project maintainers in your PR for assistance.

Thank you for contributing to Gyanchakkhu! Together, we’re building something amazing. 🌟