Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.33 KB
Raw

Contributing Guidelines

Thank you for considering contributing to markdown-parser-react! We welcome any contributions that improve the quality of the code, fix bugs, or add new features to the project.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it carefully before contributing to the project.

How to Contribute

Here are the general steps to follow when contributing to markdown-parser-react:

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes or improvements in the new branch.
  3. Run tests and ensure that they all pass. If there are any errors, fix them before submitting a pull request.
  4. Submit a pull request with a clear description of your changes and why they are needed.
  5. Wait for feedback from the maintainers or contributors.

Development

To set up the project for local development, follow these steps:

  1. Clone the repository: git clone https://github.com/{username}/{repo}.git
  2. Install dependencies: npm install or yarn
  3. Run the dev server: npm run dev or yarn dev

Reporting Bugs

If you encounter a bug while using markdown-parser-react, please create a new issue on our GitHub repository and include a clear description of the problem, the expected behavior, and any relevant code examples or screenshots.

Feature Requests

If you have an idea for a new feature or improvement, feel free to create a new issue on our GitHub repository and describe the feature or improvement in detail.

Pull Request Process

When submitting a pull request, please follow these guidelines:

  1. Use a clear and concise title for your pull request.
  2. Include a detailed description of your changes and why they are needed.
  3. Ensure that your changes are covered by tests and that all tests pass.
  4. Make sure that your code is formatted properly and follows the existing code style.
  5. Include a screenshot or GIF if your changes affect the user interface.

Once you have submitted your pull request, one of the maintainers will review it and provide feedback or merge it if it meets our standards.

Thank you for contributing to markdown-parser-react!