Skip to content

Latest commit

 

History

History
118 lines (78 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

118 lines (78 loc) · 3.7 KB
Raw

Contributing to React Code Renderer

Thank you for considering contributing to the React Code Renderer project! Your contributions are highly appreciated.

Table of Contents

Getting Started

First off, thank you for taking the time to contribute! Before you start, please make sure to familiarize yourself with the project's codebase and read through this guide.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please be respectful and considerate of others.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on the GitHub Issues page with the following information:

  • Describe the bug: Provide a clear and concise description of what the bug is.
  • Steps to reproduce: Include steps to reproduce the behavior.
  • Expected behavior: Describe what you expected to happen.
  • Screenshots: If applicable, add screenshots to help explain your problem.
  • Environment: Specify the version of the package, Node.js, and any other relevant information.

Suggesting Enhancements

Enhancement suggestions are welcome! Please open an issue with:

  • Use case: Explain the problem you're trying to solve.
  • Proposed solution: Describe how you think the problem should be solved.
  • Alternatives considered: Mention any alternative solutions you've considered.

Submitting Pull Requests

Before submitting a pull request:

  1. Fork the repository and create your branch from main.
  2. Follow the Style Guidelines.
  3. Include tests for your changes if applicable.
  4. Ensure all tests pass by running npm test.
  5. Update documentation if you've made changes to the API or documentation.

Pull Request Process

  • Ensure your PR is up-to-date with the latest main branch.
  • Provide a clear description of your changes.
  • Reference any related issues in your PR description.
  • Wait for review: One of the maintainers will review your PR and provide feedback.

Development Setup

Installing Dependencies

Clone the repository and install dependencies:

git clone https://github.com/ninsau/react-coderenderer.git
cd react-coderenderer
npm install

Building the Project

To build the project, run:

npm run build

Running Tests

To run tests, use:

npm test

Style Guidelines

Use Prettier and ESLint for consistent code formatting. Follow the coding conventions used in the project. Avoid including large, unrelated changes in one pull request.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the [tags on this repository](

License

This project is licensed under the ISC License - see the LICENSE file for details.

Contact

If you have any questions, feel free to reach out via GitHub issues or discussions.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please be respectful and considerate of others.