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

CONTRIBUTING update

Browse Source
This commit is contained in:
Simon Cambier
2024-10-08 20:39:25 +02:00
parent e9faa24369
commit af63186aa2
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -9,9 +9,7 @@ Please read this document before beginning work on a Pull Request.
## Preface ## Preface
- Omnisearch is a personal hobby project. I'm happy to discuss about your ideas and additions, but ultimately it is my code to grow and maintain. - Omnisearch is a personal hobby project. I'm happy to discuss about your ideas and additions, but ultimately it is my code to grow and maintain.
- Always file an issue/feature request before working on a PR, to make sure we're aligned and no-one is making useless work. - ❗ Always file an issue/feature request before working on a PR, to make sure we're aligned and no-one is making useless work.
- 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
## "Good First Issue" ## "Good First Issue"
@@ -21,7 +19,7 @@ If you wish to work on one of these issues, leave a comment and I'll assign it t
## Code guidelines ## Code guidelines
- Respect the existing style - ❗ By default, start your fork from the `develop` branch. If the `develop` branch is behind `master`, then use `master`. When in doubt, ask :)
- Don't add npm dependencies if you can avoid it. If a new dependency is unavoidable, be mindful of its size, freshness and added value. - Don't add npm dependencies if you can avoid it. If a new dependency is unavoidable, be mindful of its size, freshness and added value.
- Use Svelte for all UI needs. - Use Svelte for all UI needs.
- Try to not shoehorn your code into existing functions or components. - Try to not shoehorn your code into existing functions or components.
@@ -46,3 +44,4 @@ Always respect those UI & UX points:
- .ts files must be formatted with "Prettier ESLint" - .ts files must be formatted with "Prettier ESLint"
- .svelte files must be formatted with "Svelte for VS Code" - .svelte files must be formatted with "Svelte for VS Code"
- All CSS code **must** go into styles.css, and all classes should be properly named for easy customization. Do **not** use `<style>` tags in Svelte components