Contributing
Thanks for helping improve vimcolorschemes.
Before you start
Section titled “Before you start”Choose the path that matches your change:
- Use the frontend path for app UI and website behavior.
- Use the full stack path for Worker, database, and generated data changes.
- Read Architecture if you are unsure where a change belongs.
Open a pull request
Section titled “Open a pull request”- Fork the relevant repository.
- Create a branch for your change.
- Make the change.
- Run the relevant local checks.
- Open a pull request with a description and validation notes.
What to include
Section titled “What to include”In your pull request, include:
- The problem you are solving.
- The part of the system you changed.
- The checks you ran.
- Screenshots for visible UI changes.
- Notes about database, Worker, or generated data changes.
Repository links
Section titled “Repository links”- App: vimcolorschemes/vimcolorschemes
- Worker: vimcolorschemes/worker
- Extractor: vimcolorschemes/extractor.nvim
- Docs: vimcolorschemes/docs
If local setup fails, open an issue in the repository you are working on.