From 9cf337c86f6ef1673e0b606e81d9b46f191e67b1 Mon Sep 17 00:00:00 2001 From: Md Sabbir Hossain <87397638+sksabbirhossain@users.noreply.github.com> Date: Sun, 26 Nov 2023 00:01:32 +0600 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0d5e850 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing Guidelines + +Welcome to the [megamart-ecommerce] repository! We appreciate your interest in contributing. By contributing to this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). + +## Getting Started + +If you're new to contributing to open source, or if you're unfamiliar with this project, the following steps will help you get started: + +1. Fork the repository on GitHub. +2. Clone your forked repository (`git clone https://github.com/sksabbirhossain/megamart-ecommerce.git`). +3. Create a new branch for your changes (`git checkout -b feature/your-feature`). + +## Making Changes + +Before making any significant changes, please check the [issues](https://github.com/sksabbirhossain/megamart-ecommerce/issues) section to see if your change is already being discussed or if it's already in progress. + +If you plan to contribute a new feature or address a bug, it's a good idea to discuss it on the relevant issue tracker. If there isn't an existing issue, feel free to open one. + +## Coding Standards + +Please follow the coding style and standards used in this project. If there is a specific style guide for your programming language, adhere to it. + +## Submitting Changes + +When you are ready to submit your changes: + +1. Make sure your code is well-tested. +2. Ensure your code follows the project's coding standards. +3. Update the documentation if necessary. +4. Push your changes to your fork. +5. Submit a pull request to the upstream repository. + +## Pull Request Guidelines + +- Provide a clear and descriptive title for your pull request. +- Reference any related issues in the pull request description using the `#` symbol (e.g., #123). +- Ensure that your branch is up-to-date with the main branch. +- Include relevant test cases that cover your changes. + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. + +Thank you for contributing! +