CONTRIBUTING.md

Contributing to Carbonize

Thank you for your interest in contributing to Carbonize! By participating in this project, you can help improve and enhance this command-line tool for generating DOCX documents from templates.

Before you start, please take a moment to review the following guidelines to ensure a smooth and effective contribution process.

Table of Contents

• How Can I Contribute?
• Getting Started
• Reporting Bugs
• Requesting Features
• Code Contribution
  • Fork and Clone
  • Create a Branch
  • Code Changes
  • Testing
  • Submit a Pull Request
• Code of Conduct
• License

How Can I Contribute?

There are several ways you can contribute to Carbonize:

• Reporting Bugs: Help us identify and resolve issues by reporting any bugs or problems you encounter.
• Requesting Features: Share your ideas and suggestions for new features or enhancements.
• Code Contribution: Contribute code improvements, bug fixes, or new features to the project.

Getting Started

Before you start contributing, please ensure you have:

• Node.js and npm installed on your development environment.
• Git for version control.

Reporting Bugs

If you come across any issues, such as bugs or unexpected behavior, please create a new issue on our GitHub repository. Be sure to provide detailed information about the problem you encountered, including any error messages, steps to reproduce the issue, and your environment setup.

Requesting Features

We welcome feature requests and enhancements. You can submit your ideas by creating a new issue on our GitHub repository. Please describe the feature you'd like to see, its use case, and any additional context or information that may be helpful.

Code Contribution

If you'd like to contribute code changes, please follow these steps:

Fork and Clone

1. Fork the Carbonize repository by clicking the "Fork" button on the GitHub repository page.
2. Clone your forked repository to your local development environment:

git clone https://github.com/chokri/carbonize.git

3. Navigate to the project directory:

cd carbonize

Create a Branch

Create a new branch for your code changes. Make sure your branch name is descriptive and related to the issue or feature you're working on:

git checkout -b feature/your-feature-name

Code Changes

Make your code changes, improvements, or additions. Please ensure your code adheres to the project's coding style and conventions.

Testing

Test your changes to ensure they work as expected. If applicable, add or update tests to cover your code changes.

Submit a Pull Request

1. Commit your changes and push them to your forked repository:

git commit -m "Your descriptive commit message"
git push origin feature/your-feature-name

2. Visit the GitHub page of your forked repository and click on the "New Pull Request" button.
3. Provide a descriptive title and detailed description for your pull request.
4. Submit the pull request for review.

Once your pull request is submitted, it will undergo a review process. We appreciate your patience during this process, and your contribution will be reviewed and considered for merging into the main project.

Code of Conduct

Please note that by participating in this project, you are expected to adhere to our Code of Conduct. We aim to create a welcoming and inclusive community for all contributors.

License

By contributing to Carbonize, you agree that your contributions will be licensed under the MIT License.