Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (40 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

70 lines (40 loc) · 2.85 KB

Contributing to GrafikJS

Thank you for considering contributing to GrafikJS! Your contributions help us improve and expand our library for creating interactive SVG graphics on the web. Whether you're interested in adding new features, fixing bugs, or creating integrations with different frameworks, we welcome your participation.

Getting Started

To begin contributing, follow these steps:

  1. Fork the GrafikJS repository on GitHub.

  2. Clone your forked repository locally:

git clone https://github.com/andraswebcode/grafikjs.git
cd grafikjs
  1. Install dependencies:
npm install
  1. Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name
  1. Make your changes to the codebase. Ensure to follow our coding standards and conventions.

Developing Angular and Svelte Packages

We are currently developing the Vue.js package for GrafikJS, and we are looking for developers interested in helping us create Angular and Svelte packages. These packages should adhere to the structure and functionality established by the Vue.js package for consistency across frameworks. If you're familiar with Angular or Svelte and SVG manipulation, your expertise would be invaluable in creating these integrations.

Fixing Bugs

You can also contribute by fixing bugs across different GrafikJS packages, including the core package and framework-specific packages like Vue.js. If you encounter an issue or identify a bug, please follow these steps:

  1. Check Existing Issues: Search the issue tracker on GitHub to see if the bug has already been reported.

  2. Create a New Issue: If the bug is not yet reported, create a new issue detailing the problem, including steps to reproduce it.

  3. Fix the Bug: Fork the repository, create a branch for your fix, make the necessary changes, and submit a pull request. Reference the issue number in your pull request description.

Submitting Pull Requests

When you're ready to submit your changes:

  1. Commit Your Changes: Use clear and descriptive commit messages to explain your modifications.

  2. Push Your Branch: Push your changes to your forked repository:

git push origin feature/your-feature-name
  1. Submit a Pull Request: Go to the GrafikJS repository on GitHub and submit a pull request from your branch to the master branch.

Code Review

All contributions undergo code review. Be prepared to respond to feedback and make necessary changes to your pull request.

License

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

Get in Touch

If you have any questions, ideas, or need assistance, feel free to reach out on our GitHub repository. We look forward to collaborating with you to enhance GrafikJS and empower developers in creating visually compelling web applications.