diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d430c6e..03c0981 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -44,7 +44,7 @@ jobs: id: git-cliff with: config: cliff.toml - args: --verbose + args: -vv --latest --strip header env: GITHUB_REPO: ${{ github.repository }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 461dd16..fdfec7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,9 +9,7 @@ Please read this document before beginning work on a Pull Request. ## 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. -- 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 +- ❗ Always file an issue/feature request before working on a PR, to make sure we're aligned and no-one is making useless work. ## "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 -- 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. - Use Svelte for all UI needs. - 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" - .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 `