92 lines
2.5 KiB
Markdown
92 lines
2.5 KiB
Markdown
|
|
# Contributing to BentoPDF
|
|
|
|
First off, thank you for considering contributing to **BentoPDF**! Your help makes this project better for everyone.
|
|
|
|
This document outlines how to contribute, report issues, and get involved in the project.
|
|
|
|
---
|
|
|
|
## 1. How to Contribute
|
|
|
|
You can contribute in several ways:
|
|
|
|
- **Reporting Bugs:** If you find a bug or unexpected behavior, please open an issue. Include steps to reproduce and any relevant screenshots or logs.
|
|
- **Feature Requests:** Suggest new features or improvements by opening an issue and describing your idea clearly.
|
|
- **Code Contributions:** Submit a pull request with new features, bug fixes, or improvements.
|
|
- **Documentation:** Help improve the README, usage examples, or guides.
|
|
- **Testing:** Help test new releases or changes to ensure stability.
|
|
|
|
---
|
|
|
|
## 2. Getting Started with Code Contributions
|
|
|
|
1. **Fork the Repository**
|
|
```bash
|
|
git clone https://github.com/alam00000/bentopdf.git
|
|
cd bento-pdf
|
|
npm install
|
|
```
|
|
|
|
2. **Create a New Branch**
|
|
```bash
|
|
git checkout -b feature/my-new-feature
|
|
```
|
|
|
|
3. **Make Your Changes**
|
|
- Follow the code style and conventions used in the project.
|
|
- Add comments where necessary.
|
|
- Update or add tests if applicable.
|
|
|
|
4. **Run Tests**
|
|
```bash
|
|
npm run test
|
|
```
|
|
|
|
5. **Commit Your Changes**
|
|
```bash
|
|
git add .
|
|
git commit -m "Add a meaningful commit message"
|
|
```
|
|
|
|
6. **Push and Submit a Pull Request**
|
|
```bash
|
|
git push origin feature/my-new-feature
|
|
```
|
|
- Open a pull request on GitHub and provide a clear description of your changes.
|
|
|
|
---
|
|
|
|
## 3. Code Style
|
|
|
|
- Follow the existing TypeScript and JavaScript conventions.
|
|
- Use `camelCase` for variables and functions.
|
|
- Keep lines reasonably short and readable.
|
|
- Comment complex logic for clarity.
|
|
|
|
---
|
|
|
|
## 4. Issues and Pull Requests
|
|
|
|
- Make sure your PR is focused and addresses a single issue or feature.
|
|
- Reference related issues in your PR description (e.g., `Closes #12`).
|
|
- Be responsive to feedback and make requested changes promptly.
|
|
|
|
---
|
|
|
|
## 5. Reporting Security Issues
|
|
|
|
If you discover a security vulnerability, please **do not** open a public issue. Instead, contact the project maintainer directly at:
|
|
|
|
**Email:** [contact@bentopdf.com](mailto:contact@bentopdf.com)
|
|
|
|
---
|
|
|
|
## 6. Code of Conduct
|
|
|
|
All contributors are expected to follow the Code of Conduct. Be respectful and considerate in all communications.
|
|
|
|
---
|
|
|
|
Thank you for helping make **BentoPDF** a better library for everyone!
|