dom-to-pptx
Version:
A client-side library that converts any HTML element into a fully editable PowerPoint slide. **dom-to-pptx** transforms DOM structures into pixel-accurate `.pptx` content, preserving gradients, shadows, rounded images, and responsive layouts. It translate
73 lines (47 loc) • 2.46 kB
Markdown
# Contributing to dom-to-pptx
We welcome contributions to `dom-to-pptx`! To ensure a smooth and effective collaboration, please follow these guidelines.
## How to Contribute
1. **Fork the Repository:** Start by forking the `dom-to-pptx` repository to your GitHub account.
2. **Clone Your Fork:** Clone the forked repository to your local machine:
```bash
git clone https://github.com/atharva9167j/dom-to-pptx.git
cd dom-to-pptx
```
3. **Create a New Branch:** Create a new branch for your feature or bug fix:
```bash
git checkout -b feature/your-feature-name
# or
git checkout -b bugfix/issue-description
```
4. **Install Dependencies:** Install the project dependencies:
```bash
npm install
```
5. **Make Your Changes:** Implement your feature or bug fix. Ensure your code adheres to the project's coding style and passes all tests.
6. **Run Tests:** Before submitting, run the tests to ensure everything is working correctly:
```bash
npm test
```
7. **Lint and Format:** Ensure your code is properly linted and formatted:
```bash
npm run lint
npm run format
```
8. **Commit Your Changes:** Commit your changes with a clear and concise commit message. We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
```bash
git commit -m "feat: Add new feature"
# or
git commit -m "fix: Fix a bug"
```
9. **Push to Your Fork:** Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```
10. **Create a Pull Request:** Open a pull request from your fork to the `master` branch of the `dom-to-pptx` repository. Provide a detailed description of your changes.
## Code Style
We use ESLint for linting and Prettier for code formatting. Please ensure your code passes linting and formatting checks before submitting a pull request.
## Reporting Bugs
If you find a bug, please open an issue on the [GitHub Issues](https://github.com/atharva9167j/dom-to-pptx/issues) page. Provide as much detail as possible, including steps to reproduce the bug, expected behavior, and actual behavior.
## Feature Requests
If you have a feature request, please open an issue on the [GitHub Issues](https://github.com/atharva9167j/dom-to-pptx/issues) page. Describe your idea clearly and explain why it would be beneficial to the project.
Thank you for contributing!