Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 2.29 KB

Contributing to Badge Maker Lite

Thank you for considering contributing to the Badge Maker Lite! We welcome contributions of all kinds: new features, bug fixes, documentation improvements, or optimizations.

How to Contribute

1. Fork the Repository

Fork the repository on GitHub by navigating to BadgeSVGen and clicking the "Fork" button.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/yourusername/BadgeSVGen.git
cd BadgeSVGen

3. Create a Branch

Create a new branch for your feature or bugfix:

git checkout -b my-feature-branch

4. Make Your Changes

  • Follow the existing code style and best practices.
  • Keep your commits focused and meaningful.
  • Write clear commit messages.

5. Test Your Changes

Ensure that your changes work as expected by running the application locally:

npm install
npm start

6. Submit a Pull Request

Push your branch to your forked repository and open a pull request against the main repository:

git push origin my-feature-branch

When opening a pull request, please provide a detailed description of your changes and why they are necessary.

Best Practices

  • Code Style: Follow the existing code style. We use ESLint and Prettier for consistent code formatting.
  • Documentation: Ensure documentation is updated to reflect any changes you make.
  • Commit Messages: Write clear, concise commit messages. Use the imperative mood, e.g., "Add feature X" or "Fix bug Y".
  • Pull Requests: Keep pull requests focused and avoid mixing unrelated changes.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on the GitHub Issues page. Provide as much detail as possible to help us address the issue.

Interested on a colab ?

Nice! This project comes with it's own inbox: [email protected]
E-Mails received here are another way of getting in contact with me, I would love to hear if you have ideas where to take this project next.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.