diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4000b7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# Contributing to Demo Store with Commerce.js and Next.js 🛍️💳 + +Thank you for considering contributing to Demo Store with Commerce.js and Next.js 🛍️💳! We welcome contributions from the community to help make this project better. Please take a moment to read the following guidelines. + +## Code of Conduct + +Before you start contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to adhere to these rules to maintain a respectful and welcoming community. + +## How to Contribute + +There are several ways you can contribute to this project: + +1. **Reporting Issues**: If you encounter any issues or bugs, please open a GitHub issue. Provide as much detail as possible, including steps to reproduce the problem and your environment. + +2. **Suggesting Enhancements**: If you have ideas for improvements, features, or enhancements, feel free to open an issue to discuss and suggest your ideas. + +3. **Contributing Code**: We appreciate code contributions! Here's how you can contribute: + - Fork the repository. + - Create a branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `bugfix/issue-number`. + - Write your code and commit changes with clear messages. + - Push your branch to your fork. + - Submit a pull request (PR) to the main repository's `main` branch. + - Ensure that your PR is clear and includes a description of the changes. + - Make sure your code follows our coding standards. + - Respond to any review comments and address them. + +4. **Documentation**: Help us improve documentation by suggesting changes or providing new documentation as needed. + +## Getting Started + +To get started with contributing, follow these steps: + +1. [Fork](https://github.com/chec/commercejs-nextjs-demo-store/fork) the repository to your GitHub account. + +2. Clone your forked repository to your local development environment: + ```` + git clone https://github.com/your-username/commercejs-nextjs-demo-store.git + ```` + ```` + cd commercejs-nextjs-demo-store + ```` +3. Create a new branch for your contribution: + ```` + git checkout -b feature/your-feature-name + ```` +4. Make your changes and commit them: + ```` + git add . + ```` + ```` + git commit -m "Add your commit message here" + ```` +5. Push your changes to your forked repository: + ```` + git push origin feature/your-feature-name + ```` +6. Open a pull request from your branch to the main repository's main branch. + +## Coding Standards +We follow a set of coding standards and best practices. When contributing, please make sure your code aligns with our standards. + +## Contact +If you have questions or need assistance, feel free to reach out to us by creating an issue or contacting Your Name. +We appreciate your contributions and look forward to collaborating with you! 🚀