obsidian-plugin/nathonius_obsidian-github-link
1
0
Fork 0
mirror of https://github.com/nathonius/obsidian-github-link.git synced 2026-07-22 09:20:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

📚 docs: #46 Add CONTRIBUTING.md

Browse source 
Closes: #46
This commit is contained in:
Nathan Smith 2024-03-29 20:37:19 -04:00
parent fa32ee196a
commit aeeb932456
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,20 @@
# Pre-requisites
Before making a pull request, please make an associated issue. New features should be discussed with project maintainers first. Bug fixes require no discussion.
# Setup & Development
1. Clone the repo somewhere outside of your obsidian vault directory
2. `npm install` (once)
3. `npm run dev` to run a watch process that will rebuild the plugin automatically when files change
4. After making changes, in another terminal window, `cp main.js styles.css manifest.json /path/to/your/vault/.obsidian/plugins/obsidian-github-link`
5. Reload obsidian
# Code Standards
Code must meet the following standards:
- Conforms to the code style enforced by prettier
- Pass linting using the project's ESLint config (automated as a PR check)
- Pass a static code analysis scan by SonarCloud (automated as a PR check)
- Review by a project maintainer