Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 2.12 KB

contributing.md

File metadata and controls

30 lines (24 loc) · 2.12 KB

Contribute to this Project

Before jumping in, I'd say that the VS Code theme color reference is a really great resource to get started with.

Follow these steps...

  1. Fork this repo
  2. Open the forked repo in your terminal and run npm install
  3. Start to watch for changes with npm start - this runs a nodemon task that creates a .vsix file in the root directory and will automatically recompile any changes you make - it might take a while to create.
  4. Open the repo in VS Code
  5. Launch your command palette Ctrl/Cmd+Shift+P and type VSIX. Select the one that says Extensions: Install from VSIX...
  6. Load the VSIX file you created a few steps back
  7. Set your editor to use this theme - change the name in package.json to something like "Palenight Dev" so you can differentiate from the initial theme you installed from the Marketplace.
  8. Go to the debug sidebar View → Debug
  9. Hit the green arrow beside "Launch Extension" - opens a new window
  10. Make a change, and then hit the refresh button on your debug toolbar - this is in your first editor - not the one that popped open.
  11. Wait a sec, your changes should now be reflected!
  12. Duplicate your changes in the other variants
  13. Commit your changes to your fork of this repo
  14. Send a PR that contains detailed information about your change
  15. I'll review it, and decide whether it should be merged 📖.

Things You might want to help with

  • Automate copying every change in a JSON file into the variants. Say, you edit palenight.json, your changes should get duplicated in palenight-italic.json and palenight-operator.json.
  • Create a functionality that'll group the code for each language in separate files. Say, javascript.json, css.json and would automtically be merged into one file on build.
  • Create a high contrast variant.
  • Help update the Atom version.

If you get stuck somewhere, feel free to reach out to me on Twitter 😄.