Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (58 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

92 lines (58 loc) · 1.94 KB

🤝 Contribution Guidelines

Thank you for considering contributing to GitHub Username Generator! 🚀
Your help makes this project better for everyone.

📌 How Can You Contribute?

Before Contributing Read ➡️ Project Documentation For Detailed Guide.

You can contribute by:

  • 🐞 Reporting bugs
  • ⚡ Suggesting new features
  • 🛠️ Improving existing code
  • 🎨 Enhancing UI/UX design
  • 📚 Improving documentation

🔧 Contribution Steps

  1. Fork this repository:
    Click the Fork button in the top right of this page.

  2. Clone your fork to your local machine:

    git clone https://github.com/alamimran613/github-username-generator.git

  3. Create a new branch:

    git checkout -b feature-branch

  4. Make your changes inside the relevant files.

  5. Commit your changes:

    git add .
git commit -m "Added new feature or fixed issue #issue_number"

  6. Push to your fork:

    git push origin feature-branch

  7. Create a Pull Request (PR):
    Open a PR from your branch into the main branch of this repo.

📌 Before Submitting

  • Make sure your code follows best practices (clean, readable, commented).
  • Test your changes locally before submitting.
  • If your PR fixes an issue, reference it in the commit message (e.g., fixes #12).
  • Keep PRs small and focused for easier review.

📌 Reporting Issues

If you find a bug, please open an Issue with:

  • Clear description
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)

🙌 Code of Conduct

By participating, you agree to uphold the project’s values of respect, inclusivity, and collaboration.

⭐ Show Support

If you like this project, please star the repository. It motivates us to improve further!

Happy Coding! 🎉
— Imran Alam / TechnoSnag