Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (58 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

96 lines (58 loc) · 2.68 KB

Contributing to MetaRang Frontend Project

Thank you for considering contributing to the MetaRang Frontend Project! We welcome contributions of all kinds, from bug reports and suggestions to code contributions and documentation improvements.

Getting Started

Follow the steps below to clone the repository and start working on it.

1. Clone the Repository

To start working on the project, clone the repository to your local machine:

git clone https://github.com/iranpsc/Metaverse-Rang-Front-NextJS.git

2. Navigate to the Project Directory

Once the repository is cloned, navigate to the project directory:

cd Metaverse-Rang-Front-NextJS

3. Install Dependencies

Before running the project, make sure to install all the required dependencies:

npm install

4. Run the Project

Start the development server on port 5175:

npm run dev

You can now access the project at http://localhost:5175.

Coding Standards

Please adhere to the following coding standards to ensure consistency and quality across the codebase:

  • Indentation: Use 2 spaces for indentation.
  • Comments: Comment your code where necessary to explain complex logic.
  • Variable Naming: Use meaningful and descriptive variable names written in camelCase.
  • Commit Messages: Write clear and concise commit messages that describe the changes made.
  • Testing: Ensure that all new features and bug fixes are thoroughly tested.

Pull Request Process

To submit a pull request, follow the steps below:

1. Create a New Branch

When working on a new feature or bug fix, create a new branch from the main branch:

git checkout -b feature-or-bugfix-name

2. Make Your Changes

Make your changes on this branch and test thoroughly.

3. Commit Your Changes

Once your changes are ready, commit them with a meaningful message:

git commit -m "A clear and concise description of the changes"

4. Push the Branch

Push your branch to your fork of the repository:

git push origin feature-or-bugfix-name

5. Open a Pull Request

Navigate to the GitHub repository and open a pull request from your branch to the main branch. In your pull request description, provide a detailed explanation of the changes and any relevant information.

Merge Process

  • All pull requests must be reviewed and approved by at least one other contributor before they can be merged.
  • Ensure that your code passes all tests and linting checks before requesting a review.
  • After approval, a maintainer will merge the pull request into the main branch.

Thank you for following the contribution guidelines and helping improve MetaRang Frontend Project!