Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve developer docs #241

Open
sbliven opened this issue Nov 11, 2024 · 0 comments
Open

Improve developer docs #241

sbliven opened this issue Nov 11, 2024 · 0 comments

Comments

@sbliven
Copy link

sbliven commented Nov 11, 2024

I tried to make some small fixes and came away frustrated with building the plugin. I'm familiar with typescript and npm so I expected this to be as simple as npm run build. However, the main branch (a8aa7e) fails to build currently, and without a CONTRIBUTING file or other developer-oriented documentation it wasn't obvious whether this was a problem with my installation or with the code.

I suggest adding CONTRIBUTING.md file with the following:

  • Commands to build the software
  • How to install a dev plugin in obsidian (eg with symlinks, possibly using helper plugins like hot-reload)
  • What is expected of pull requests (eg pass lint)

You have CI actions set up, so enforcing that main builds and passes lint should be achievable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant