The Community Website is a centralized hub for showcasing open-source projects, connecting contributors, and fostering collaboration.
We love contributions from everyone! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is always appreciated. Here's how you can contribute:
Follow the steps below to contribute effectively:
-
Fork the Repository: Start by forking the repository to your own GitHub account.
-
Clone the Repository: Clone the forked repository to your local development environment.
git clone https://github.com/your-username/community-website.git -
Create a New Branch Locally: Create a branch for your feature or fix. Name your branch in a way that describes the purpose of your changes. For example:
feature/feature-namebugfix/bug-descriptiondocs/clarify-setup-instructions
-
Make Your Changes:
- Add your code, features, or bug fixes.
-
Commit Guidelines: When committing changes to your branch, please follow this naming scheme to keep commit history clean and readable:
Commit message format: <type>:<short-description>
Types:
feat: A new feature or functionality added to the project.
fix: A bug fix.
docs: Documentation changes.
style: Code style changes (e.g., formatting, missing semicolons).
refactor: Code changes that neither fix a bug nor add a feature, but improve the structure.
test: Adding or modifying tests.
chore: Changes to the build process or auxiliary tools.
Example Commit Messages:
feat: add user authentication to the website
fix: resolve issue with missing image on homepage
docs: update README.md with contribution guidelines
style: format code according to ESLint rules
test: add unit test for login function
chore: update dependencies to latest version
-
Push and Create a Pull Request: Once you're ready, push your changes to your forked repository and open a pull request to the
devrepository. -
Follow Up We will review your changes and may provide feedback. Please address any comments or requested changes, and we’ll merge your contribution!
- Always follow the coding style and best practices.
- Keep PRs concise and focused on a single feature or fix.
- Stay engaged in the discussions and suggest improvements.
Thank you for being a valuable part of our community! 🎉
Join our Discord community for more discussions and updates!
