Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (17 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.07 KB

Contributing to mindstage-sdk

Thank you for your interest in contributing to the MindMap SDK! We welcome contributions from the community to help make this the best open-source mind map engine.

How to Contribute

  1. Fork the Repository: Create a fork of the repository on GitHub.
  2. Clone the Fork: Clone your fork to your local machine.
  3. Create a Branch: Create a new branch for your changes.
  4. Make Changes: Implement your changes and ensure they follow our coding standards.
  5. Run Tests: Ensure all tests pass by running npm run test.
  6. Commit Changes: Commit your changes with a clear and descriptive message.
  7. Push and PR: Push your changes to your fork and create a Pull Request to the main repository.

Coding Standards

  • Follow the existing code style and structure.
  • Use TypeScript for all new code.
  • Write clear and concise commit messages.
  • Add tests for new features and bug fixes.

Community

If you have any questions or need help, feel free to open an issue or reach out to us at MindStage.