Skip to main content

​
Welcome Contributors

We welcome contributions from the community! Since Blink is built from scratch (not a VS Code fork), we’re especially looking for developers interested in performance optimization and core architecture. Blink Code Editor is focused on eliminating every millisecond of latency while maintaining a lightweight footprint. Your contributions help us achieve this goal.

​
Getting Started

1

Fork the Repository

Start by forking the Blink Code Editor repository to your GitHub account. This creates your own copy where you can make changes.
# Clone your fork
git clone https://github.com/YOUR_USERNAME/blink-code-editor.git
cd blink-code-editor
2

Create a Feature Branch

Create a dedicated branch for your feature or bug fix. Use descriptive names that clearly indicate what you’re working on.
# Create and switch to a new branch
git checkout -b feature/your-feature-name
# or for bug fixes
git checkout -b fix/bug-description
3

Make Your Changes

Implement your feature or fix with a focus on:
  • Performance: Every millisecond matters
  • Code Quality: Clean, maintainable code
  • Testing: Ensure your changes work as expected
  • Documentation: Update docs if needed
4

Commit Your Work

Write clear, descriptive commit messages that explain what and why.
git add .
git commit -m "feat: add feature description"
# or
git commit -m "fix: resolve issue description"
5

Submit a Pull Request

Push your branch and create a Pull Request with a detailed description of your changes.
git push origin feature/your-feature-name
Include in your PR description:
  • What changes you made
  • Why you made them
  • Any relevant issue numbers
  • Screenshots or demos if applicable

​
Development Workflow

​
Setting Up Your Environment

Blink Code Editor is built from the ground up, so make sure you have the necessary build tools and dependencies installed for your platform (Windows or Linux).
# Install dependencies
npm install
# or
yarn install

# Run in development mode
npm run dev

# Build for production
npm run build

​
Areas We Need Help

If you have experience with performance profiling, memory optimization, or rendering performance, we’d love your contributions. Blink is all about speed and responsiveness.
Since Blink is built from scratch, contributions to the core architecture are particularly valuable. This includes the editor core, file system handling, and UI framework.
We’re currently working on Language Server Protocol integration. If you have experience with LSP, this is a great area to contribute.
Help us build a robust custom theme engine that maintains performance while offering flexibility.
Help us maintain stability by writing tests, finding bugs, and improving our QA processes.

​
Code of Conduct

​
Our Standards

  • Be Respectful: Treat all contributors with respect and professionalism
  • Be Collaborative: Work together to solve problems and improve the project
  • Be Constructive: Provide helpful feedback and accept criticism gracefully
  • Focus on Quality: Prioritize code quality and performance in all contributions
  • Stay on Topic: Keep discussions relevant to the project

​
Expectations

  • Write clean, maintainable code that follows the project’s coding standards
  • Test your changes thoroughly before submitting
  • Document new features and update existing documentation
  • Be responsive to feedback on your pull requests
  • Focus on performance optimization in all contributions

​
Pull Request Guidelines

Provide a detailed description of your changes when submitting a pull request. This helps maintainers understand your work and speeds up the review process.

​
What to Include

  1. Clear Title: Use a descriptive title that summarizes the change
  2. Description: Explain what changes you made and why
  3. Related Issues: Reference any related issues or discussions
  4. Testing: Describe how you tested your changes
  5. Screenshots: Include visual proof for UI changes
  6. Breaking Changes: Clearly mark any breaking changes

​
Review Process

Once submitted, your PR will be reviewed by maintainers who will:
  • Check code quality and adherence to standards
  • Verify performance impact
  • Test functionality
  • Provide feedback or request changes
  • Merge approved contributions

​
Questions or Need Help?

If you have questions about contributing or need help getting started, feel free to:
  • Open an issue on GitHub
  • Join our community discussions
  • Reach out to maintainers
We appreciate your interest in making Blink Code Editor better!

Build docs developers (and LLMs) love

Get started for freeTalk to us