Contributing to The FullStack Pro Kit We appreciate your interest in contributing to this project! This document outlines the guidelines and best practices for submitting your contributions. By following these rules, you help us maintain a high-quality codebase and a collaborative community.
Code of Conduct Please review and adhere to our Code of Conduct. This helps ensure a positive and inclusive environment for everyone.
How to Contribute Fork the Repository: Start by forking the FullStack-Pro-Kit repository to your own GitHub account.
Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/FullStack-Pro-Kit.git cd FullStack-Pro-Kit
Create a New Branch: Always create a new branch for your changes. Use a descriptive name that reflects the nature of your work (e.g., feat/add-user-authentication, fix/login-bug).
git checkout -b your-new-branch-name
Make Your Changes: Write your code, add new features, or fix bugs. Ensure your code is well-commented and follows the existing code style.
Commit Your Changes: Commit your changes with a clear and concise commit message.
git commit -m "feat: Describe your feature or fix in a short sentence"
Push to Your Fork: Push your new branch to your forked repository.
git push origin your-new-branch-name
Create a Pull Request: Go to the original FullStack-Pro-Kit repository on GitHub and open a new Pull Request. Provide a detailed description of your changes, what problem they solve, and any other relevant information.
Pull Request Guidelines Single Purpose: Each Pull Request should address a single issue or feature. Avoid combining unrelated changes.
Clear Description: The PR description should be detailed and include screenshots or GIFs where appropriate.
Review Process: Your Pull Request will be reviewed by the maintainers. Be prepared to discuss your changes and make requested adjustments.