Thank you for your interest in contributing to Packigician! We welcome contributions from everyone. Here's how you can help:
-
Fork the Repository
- Click the "Fork" button on the GitHub repository
- Clone your forked repository locally
git clone https://github.com/YOUR_USERNAME/Packigician.git cd Packigician -
Set Up Development Environment
- Install Node.js (version 14 or higher)
- Install dependencies:
npm install
-
Create a Branch
- Create a new branch for your feature or bugfix:
git checkout -b feature/your-feature-name # or git checkout -b bugfix/issue-number-description -
Make Your Changes
- Write your code following the project's style
- Add tests if applicable
- Update documentation as needed
-
Test Your Changes
- Run the linter:
npm run lint
- Run tests (when available):
npm test -
Commit Your Changes
- Write clear, concise commit messages
- Reference any related issues
git commit -m "feat: add new feature" # or git commit -m "fix: resolve issue with template generation"
-
Push and Create a Pull Request
- Push your changes to your fork
- Open a pull request against the main branch
- Describe your changes and reference any related issues
- Follow the existing code style
- Use 2 spaces for indentation
- Use single quotes for strings
- Add comments to explain complex logic
When reporting issues, please include:
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Environment (Node.js version, npm version, OS)
- Any relevant error messages
By contributing to Packigician, you agree that your contributions will be licensed under the MIT License.
Thank you for helping make Packigician better! 🚀