reactjs-media
Version:
Awesome Multimedia Components for React
86 lines (55 loc) • 2.99 kB
Markdown
# Contributing to Reactjs Media
First off, thank you for considering contributing to Reactjs Media! Your support helps us improve and grow.
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating in this project, you agree to abide by its terms.
## How Can I Contribute?
### Reporting Bugs
If you've encountered a bug, please help us by submitting an issue. Before you create an issue, please check if a similar issue already exists. If it does, add any additional information as a comment.
**To report a bug:**
1. **Search Existing Issues:** Check if the issue has already been reported.
2. **Create a New Issue:** If it hasn't been reported, [open a new issue](https://github.com/jim-junior/reactjs-media/issues/new) and include:
- A clear and descriptive title.
- A detailed description of the problem.
- Steps to reproduce the issue.
- Any relevant logs or screenshots.
### Suggesting Features
We welcome new ideas to enhance the project.
**To suggest a feature:**
1. **Check Existing Issues:** Ensure the feature hasn't been suggested already.
2. **Create a New Issue:** [Open a new issue](https://github.com/jim-junior/reactjs-media/issues/new) and provide:
- A clear and descriptive title.
- A detailed description of the proposed feature.
- Rationale for why the feature is needed.
### Submitting Pull Requests
We appreciate your contributions! To ensure a smooth process:
1. **Fork the Repository:** Create your own fork of the project.
2. **Clone the Fork:** Clone your fork to your local machine.
3. **Create a Branch:** Create a new branch for your feature or bugfix.
4. **Make Changes:** Implement your changes in this branch.
5. **Commit Changes:** Write clear and concise commit messages.
6. **Push to GitHub:** Push your changes to your fork.
7. **Open a Pull Request:** From your fork, open a pull request to the main repository.
**Pull Request Guidelines:**
- **Describe Your Changes:** Provide a clear description of what your pull request does.
- **Reference Issues:** If your pull request addresses an issue, include a reference (e.g., `Closes #123`).
- **Be Responsive:** Participate in the review process and address any feedback.
## Development Setup
To set up the project locally:
1. **Clone the Repository:**
```bash
git clone https://github.com/jim-junior/reactjs-media.git
cd reactjs-media
```
2. **Install Dependencies:**
```bash
npm install
```
3. **Run the Development Server:**
```bash
npm run dev
```
All code is located in the `src` directory. and to test your component import it in the `test/demo.tsx` file.
## Coding Style
To maintain consistency, we follow the following Code Style:
- **Code Formatting:** Use [Prettier](https://prettier.io/) for code formatting.
- **Linting:** Ensure your code passes all linting rules. We utilise eslint