tanner/obsidian-tannersearch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Simon Cambier
2022-05-17 14:02:13 +02:00
committed by GitHub
parent 8c99450d3b
commit 89ac464faf
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@@ -13,6 +13,12 @@ Please read this document before beginning work on a Pull Request.
- Omnisearch is still in its infancy: some important features are missing, and there will be architectural changes. - Omnisearch is still in its infancy: some important features are missing, and there will be architectural changes.
- As such, I may refuse your PR simply because it will have to be refactored in a short-ish term - As such, I may refuse your PR simply because it will have to be refactored in a short-ish term
## "Good First Issue"
Are you a beginner, looking for a small open source contribution? Look at the "[good first issues](https://github.com/scambier/obsidian-omnisearch/labels/good%20first%20issue)". Those issues have a limited scope, don't require intricate knowledge of the code, and are easy enough to locate, fix, and test.
If you wish to work on one of these issues, leave a comment and I'll assign it to you and give you some pointers.
## Code guidelines ## Code guidelines
- Respect the existing style - Respect the existing style
@@ -38,4 +44,5 @@ Always respect those UI & UX points:
## Style guidelines ## Style guidelines
(todo) - .ts files must be formatted with "Prettier ESLint"
- .svelte files must be formatted with "Svelte for VS Code"