Stuff happens, and sometimes as best as we try, there may be issues with these Obsidian snippets that we are unaware of. That is the great thing about open-source; anyone can use the program and contribute to making it better.
If you have found a bug, have an issue with these snippets, or maybe even a cool idea; you can let us know by submitting it. However, before you submit your new issue, bug report, or feature request; head over to the Issues Section and ensure nobody else has already submitted it.
Once you are sure that your issue is not already being dealt with; you may submit it by clicking here. You'll be asked to specify exactly what your new submission targets, such as:
- Bug report
- Feature Suggestion
When submitting your new report, ensure you fill out any of the questions asked of you. If you do not provide enough information, we cannot help. Be as detailed as possible, and provide any logs or screenshots you may have to help us better understand what you mean. Failure to fill out the submission properly may result in it being closed without a response.
If you are submitting a bug report:
- Explain the issue in detail
- Describe how you expect for a feature to work, and what you're seeing instead of what you expected.
- Provide screenshots, logs, or anything else that can visually help track down the issue.
If you are looking to contribute to these Obsidian snippets and submit your own code; please review this section completely. There is important information and policies provided below that you must follow for your pull request to get accepted.
The source is here for everyone to collectively share and colaborate on. If you think you have a possible solution to a problem; don't be afraid to get your hands dirty.
All contributions are made via Pull Requests. To make a pull request, you will need a GitHub account; if you are unclear on this process, see GitHub's documentation on forking and pull requests.
- Follow the repository's code formatting conventions (see below);
- Include tests that prove that the change works as intended and does not add regressions;
- Document the changes in the code and/or the project's documentation;
- Your PR must pass the CI pipeline;
- When submitting your Pull Request, use one of the following branches:
- For bug fixes:
mainbranch - For features & functionality:
developmentbranch
- For bug fixes:
- Include a proper git commit message following the Conventional Commit Specification.
If all of these items are checked, the pull request is ready to be reviewed and your pull request's label will be changed to "Ready for Review". At this point, a human will need to step in and manually verify your submission.
Once your submission has been tested and verified; it will be merged.
When commiting your changes, we require you to follow the Conventional Commit Specification, described below.
The Conventional Commits is a specification for the format and content of a commit message. The concept behind Conventional Commits is to provide a rich commit history that can be read and understood by both humans and automated tools. Conventional Commits have the following format:
<type>[(optional <scope>)]: <description>
[optional <body>]
[optional <footer(s)>]
| Type | Description |
|---|---|
feat |
Introduces a new feature |
fix |
Bug fix for the end-user |
deps |
Specifically targets adding new or updating existing dependencies |
docs |
Change to the website or Markdown documents |
build |
Alters the build process. E.g: creating a new build task, updating the release script, etc. |
test |
Adds or refactors tests, no production code change. Usually changes the suite of automated tests for the app. |
perf |
Improves performance of algorithms or general execution time of the app, but does not fundamentally change an existing feature. |
style |
Updates or reformats the style of the source code, but does not otherwise change the way the app is implemented. Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
refactor |
Change to production code that leads to no behavior difference, E.g. splitting files, renaming internal variables, improving code style, etc. |
change |
Changes to an existing feature. |
chore |
Includes a technical or preventative maintenance task that is necessary for managing the app or the repo, such as updating grunt tasks, but is not tied to any specific feature. Usually done for maintanence purposes. |
ci |
Changes related to Continuous Integration (usually yml and other configuration files). |
misc |
Anything else that doesn't fit into another commit type. Usually doesn't change production code; yet is not ci, test or chore. |
revert |
Revert a previous commit |
remove |
Removes a feature from the app. Typically features are deprecated first for a period of time before being removed. Removing a feature from the app may be considered a breaking change that will require a major version number increment. |
deprecate |
Deprecates existing functionality, but does not remove it from the app. |
feat(toc1): add ability to filter out certain headers from displaying
^───^────^ ^────────────────────────────────^
│ │ │
│ │ └───⫸ (DESC): Summary in present tense. Use lower case not title case!
│ │
│ └───────────⫸ (SCOPE): The package(s) that this change affects
│
└───────────────⫸ (TYPE): See list above
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
│ │
│ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
│ elements|forms|http|language-service|localize|platform-browser|
│ platform-browser-dynamic|platform-server|router|service-worker|
│ upgrade|zone.js|packaging|changelog|docs-infra|migrations|ngcc|ve|
│ devtools....
│
└─⫸ Commit Type: build|ci|doc|docs|feat|fix|perf|refactor|test
website|chore|style|type|revert|deprecate
If you are pushing a commit which addresses a submitted issue, reference your issue at the end of the commit message. You may also optionally add the major issue to the end of your commit body.
References should be on their own line, following the word Ref or Refs
Title: fix(snippet): list of headers not rendering properly [#2002]
Description: The description of your commit
Ref: #2002, #3004, #3007
Align similar elements vertically, to make typo-generated bugs more obvious
let count = 0;
const path_base = dv.current().file.path
const path_targ = path_base.substr(0, path_base.lastIndexOf("/"));
const path_sub = ""
const filter_page = '"' + path_targ + "" + path_sub + '"';
const filter_folder = path_targ + path_sub;When writing your code, set your IDE to utilize spaces, with a configured tab size of 4 characters.
Comment your code. If someone else comes along, they should be able to do a quick glance and have an idea of what is going on. Plus it helps novice readers to better understand the process.
You may use block style commenting, or single lines:
/*
displays 'No Results' if user has absolutely no matching headers to show
*/
if (count === 0)
{
const rootNode = dv.el("div", "No results", { cls: "toc_results_none" });
rootNode.setAttribute("style", "text-align:center;");
}When writing your code, ensure you stick to camelCase
let myVar = 'one';
let secondVar = 'two';