Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

96 lines (60 loc) · 2.79 KB

Contributing to the Project

We appreciate your interest and efforts to contribute. Before you get started, please take a moment to review the following guidelines.

Getting Started

Issues

  • Before working on an issue, please check if it's already assigned or if someone else is already working on it. If not, feel free to assign it to yourself.
  • If you find a new issue or want to suggest an enhancement, please use our issue tracker.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report, please ensure that you have checked the latest version of the project, and that the issue persists. When submitting a bug report, please provide a detailed description along with steps to reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement, please create an issue and outline your proposal. We welcome discussions about new features or improvements.

Development Setup

If you want to set up a local development environment, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository.

   git clone https://github.com/your-username/Frontend.git
   cd Frontend
  1. Install project dependencies.
   npm install
  1. Start the development server
   npm run serve
  1. Create a new branch for your changes.
   git checkout -b your-feature-branch
  1. Make your changes and commit them.
   git add .
   git commit -m "Your descriptive commit message"
  1. Push your changes to your fork.
   git push origin your-feature-branch

Additional Steps:

  1. Build the project to ensure there are no build errors.
   npm run build
  1. Run the linter to check for coding standards.
   npm run lint
  1. Run tests to ensure your changes haven't introduced regressions.
   npm run test

If everything is successful, you're ready to create a pull request against the main branch of the original repository!

Code of Conduct

This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior.

Thank you!

Thank you for considering contributing! We appreciate your time and effort. If you have any questions or need assistance, feel free to reach out.