Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 2.46 KB

Contributing.md

File metadata and controls

78 lines (48 loc) · 2.46 KB
Raw

Contributing to BMSamay.com Frontend

We are excited that you are interested in contributing to the BMSamay.com Frontend project! Your contributions are valuable and help improve the project for everyone. Please take a moment to read through these guidelines before you get started.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please open an issue on GitHub. Include as much detail as possible to help us understand and resolve the issue:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Any relevant logs, screenshots, or additional context.

Suggesting Features

We welcome feature suggestions! If you have an idea for a new feature, please open an issue on GitHub with the following details:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any relevant examples or use cases.

Contributing Code

  1. Fork the Repository: Fork the repository on GitHub and clone it to your local machine.

    git clone https://github.com/YOUR_USERNAME/bm_frontend.git
cd bm_frontend

  2. Create a Branch: Create a new branch for your changes.

git checkout -b feature-branch

  1. Make Your Changes: Implement your changes, making sure to follow the project's coding standards and conventions.

  2. Commit Your Changes: Commit your changes with a clear and concise commit message.

git add .
git commit -m "Add detailed commit message here"
  1. Push to GitHub: Push your changes to your forked repository.
git push origin feature-branch
  1. Open a Pull Request: Open a pull request on GitHub, comparing your feature branch to the main repository's main branch. Provide a clear and detailed description of your changes.

Code Review Process

  • All submissions, including submissions by project members, require review.
  • We use GitHub's pull request process for code reviews.
  • Be sure to respond to any feedback or requested changes promptly.

Style Guide

  • Follow the existing code style in the project.
  • Use descriptive variable and function names.
  • Keep functions small and focused.
  • Write comments as necessary to explain your code.

Writing Documentation

  • If you are adding a new feature, update the documentation accordingly.
  • Ensure your documentation is clear and concise.
  • Follow the format and style of the existing documentation.

Thank you for your contributions!