From 73e78ff44f3b33bfa0fa18dcdc0b2f310b51a0e6 Mon Sep 17 00:00:00 2001 From: Sigrunixia Date: Thu, 3 Aug 2023 23:25:24 -0500 Subject: [PATCH] refactor(Templates): Templates Removed Due to Consolidation Signed-off-by: Sigrunixia --- .github/ISSUE_TEMPLATE/bug-report.yaml | 110 ----------- .github/ISSUE_TEMPLATE/code-report.yml | 38 ---- .github/ISSUE_TEMPLATE/config.yml | 1 - .../ISSUE_TEMPLATE/documentation-update.yaml | 51 ----- .github/ISSUE_TEMPLATE/feature-request.yaml | 48 ----- .../pull_request_template.md | 10 - CODE_OF_CONDUCT.md | 77 -------- CONTRIBUTING.md | 187 ------------------ 8 files changed, 522 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/code-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation-update.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml deleted file mode 100644 index b9e7560..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ /dev/null @@ -1,110 +0,0 @@ -name: Bug Report -description: File a bug report -labels: bug -assignees: Valentine195 -title: "[Bug]: " -body: - - type: markdown - attributes: - value: | - ## Before you begin - Make sure to use the latest version of the plugin. - If you face any issues after installing, updating, or reloading the plugin, try restarting Obsidian before reporting the bug. - Also, please make sure you **read and understand the **[guide for good bug reports](https://plugins.javalent.com/support/report-bug)**. - - - type: checkboxes - id: duplicate-issues - attributes: - label: "Check for existing bug reports before submitting." - description: "Use Label filters to refine your search. Check both open and closed issues to see if your issue has already been reported." - options: - - label: "I searched for existing Bug Reports and found no similar reports." - required: true - - - type: textarea - id: expected - attributes: - label: Expected Behavior - description: What *should have** happened? - validations: - required: true - - - type: textarea - id: what-happened - attributes: - label: Current behaviour - description: | - How did the issue manifest itself in reality? Including screenshots would be helpful. - validations: - required: true - - - type: textarea - id: reproduction - attributes: - label: Reproduction - description: | - Please provide us with the exact steps to reproduce the issue. - The more detail you provide, the easier it will be for us to narrow down and fix the bug. - Please ensure that you paste in codeblocks and/or queries as text, rather than screenshots. - Format your pasted text as described in Give us Text to copy. - We will not accept bug reports that require anyone to re-type text from screenshots or descriptive text. - Please note that if you're a Mac user, a Safari bug might strip newlines from your text. - placeholder: | - Example of the level of detail needed to reproduce any bugs efficiently and reliably. - Without it, your issue may get worked on last. - 1. Launch Obsidian Sandbox via the `Open Sandbox Vault` command. - 2. Install the Javalent plugin. - 3. Change the global filter to... - 4. Create a new note called `Demo problem`. - 5. Installed Dataview and Statblocks stopped working. - 6. Switch to Reading mode. - 7. etc - (Mac users: a Safari bug strips newlines from this text.) - validations: - required: true - - - type: checkboxes - id: operating-systems - attributes: - label: Which Operating Systems are you using? - description: You may select more than one. - options: - - label: Android - - label: iPhone/iPad - - label: Linux - - label: macOS - - label: Windows - - - type: input - id: obsidian-version - attributes: - label: Obsidian Version Check - description: Which Obsidian Version and Installer Version are you using? - placeholder: 1.28.7 and 1.2.7 - validations: - required: true - - - type: input - id: plugin-version - attributes: - label: Plugin Version - description: Which plugin version are you using? - placeholder: x.x.x - validations: - required: true - - - type: checkboxes - id: other-plugins-disabled - attributes: - label: Confirmation - description: Please confirm that you have completed the following steps before submitting your issue. - options: - - label: I have disabled all other plugins and the issue still persists. - required: false - - - type: textarea - id: possible-solution - attributes: - label: Possible solution - description: | - (Optional) If you have any ideas, please suggest a fix or a possible reason for the bug. diff --git a/.github/ISSUE_TEMPLATE/code-report.yml b/.github/ISSUE_TEMPLATE/code-report.yml deleted file mode 100644 index ea97a87..0000000 --- a/.github/ISSUE_TEMPLATE/code-report.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Code Report -description: Report an Update to Code -labels: ["type: Code"] -body: - - type: markdown - attributes: - value: | - ## About this form - This form is only for tracking developer-focussed actions, such as - refactoring, dependency updates and similar. - Rarely, these might be used to gauge user data. - - type: textarea - id: scope - attributes: - label: Scope - description: What is the scope of the change and why is it needed? - validations: - required: true - - - type: textarea - id: discovery - attributes: - label: Discovery - description: | - What will be changed?. - validations: - required: true - - - type: textarea - id: validation - attributes: - label: Validate - description: | - What was your environment you tested these changes in? - Do any new dependencies need to be added? - Any other pertinent information? - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 3ba13e0..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/documentation-update.yaml b/.github/ISSUE_TEMPLATE/documentation-update.yaml deleted file mode 100644 index 52e21ae..0000000 --- a/.github/ISSUE_TEMPLATE/documentation-update.yaml +++ /dev/null @@ -1,51 +0,0 @@ -name: Documentation Report -description: Request Documentation Update -labels: [ "type: Documentation" ] -body: - - type: checkboxes - id: investigation - attributes: - label: "What are we changing or adding?" - description: "Please pick where you are requesting the documentation to change." - options: - - label: "Repository" - required: false - - label: "[Publish Documentation](https://plugins.javalent.com/)" - required: false - - - - type: textarea - id: location - validations: - required: true - attributes: - label: "Location" - description: "In what section are we changing?" - placeholder: "We're changing this in the pinned threads." - - - type: textarea - id: issue - validations: - required: true - attributes: - label: "The issue is..." - description: "Describe what is the reason and motivation for this change?" - placeholder: "I do not understand this terminology that is being used here..." - - - type: textarea - id: suggestions - validations: - required: true - attributes: - label: "Suggestions?" - description: "Do you have any suggestions on what wording can be changed or added?" - placeholder: "I have pondered and here is a small write-up ..." - - - type: textarea - id: anything-else - validations: - required: true - attributes: - label: "Anything else?" - description: "Did we miss anything? What else do you want to add?" - placeholder: "I think the Settings Search song sucks, and the mascot should be Murder Gemmy." diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml deleted file mode 100644 index db666fe..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ /dev/null @@ -1,48 +0,0 @@ -name: Feature Request -description: Request a new feature -labels: [ "type: Feature" ] -body: - - type: checkboxes - id: duplicate-issues - attributes: - label: "Please make sure this feature request hasn't been suggested before." - description: "Before submitting a feature request, please check if it has already been suggested in our Discussions or Issues pages. Use the **Label filters** to refine your search." - options: - - label: "I searched previous Issues and didn't find any similar feature requests." - required: true - - - type: textarea - id: feature-description - validations: - required: true - attributes: - label: "Feature description" - description: "Please provide a clear and concise description of the feature you are requesting." - placeholder: "I would like to see ..." - - - type: textarea - id: solution - validations: - required: true - attributes: - label: "Solution" - description: "Please describe your proposed solution for this feature request, and explain why it's necessary." - placeholder: "In my use case, it would be helpful to have ..." - - - type: textarea - id: alternatives - validations: - required: true - attributes: - label: "Alternatives" - description: "Please provide any alternative solutions or features you've considered. Be clear and concise." - placeholder: "I have considered ..." - - - type: textarea - id: additional-context - validations: - required: true - attributes: - label: "Additional Information" - description: "If you have any additional context or screenshots related to your feature request, please add them here." - placeholder: "..." diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index 8747110..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,10 +0,0 @@ -# Summary - -## Related Issue - - - - - -## Anything Else? - diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index bf82a1e..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,77 +0,0 @@ -# Code of Conduct—Javalent's Plugins - -## Our Commitment - -As contributors and maintainers of Javalent's Plugins, ethics commits us to creating and maintaining an open and welcoming environment. We pledge to make participation in our project and community a harassment-free experience for everyone. - -## Our Standards - -To create a positive environment for our community, we ask that all participants uphold the following standards: - -- Demonstrate empathy and kindness towards others. -- Recognize that individuals have differing opinions and viewpoints, and that respectful communication is necessary to work towards a common goal. -- Provide and receive constructive feedback in a respectful and constructive manner. We don't tolerate personal attacks or other forms of harassment. -- Show patience and understanding when teaching or learning. -- Keep in mind the overarching goals of the Table Top Role-Playing Game (TTRPG) community. - -Examples of unacceptable behavior include: - -- Nagging, badgering, begging, or otherwise pestering maintainers and would-be contributors for a response to an issue or pull request. -- Trolling, insulting, or making derogatory comments, and engaging in personal or political attacks. -- Engaging in any form of harassment, whether in public or private. -- Publishing others' private information, such as their physical or email address, without their consent. -- Engaging in other actions designed to harm, intimidate or exclude individuals or groups of people. For example, attempting to introduce features that are completely inaccessible to non-SRD DnD players. - -## Our Responsibilities - -As project maintainers, we're responsible for upholding and enforcing our standards of acceptable behavior. We will take appropriate and corrective action in response to any behavior that we deem inappropriate, threatening, offensive, or harmful. - -We've the right and responsibility to remove, edit or reject comments, commits, code, wiki edits, issues and other contributions that don't align with this Code of Conduct. We will communicate reasons for moderation decisions when appropriate. - -## Scope - -This Code of Conduct applies to all community spaces associated with Javalent, including Discord. -It applies when a person is also representing the community in any official capacity. -For instance, as when as in other GitHub repositories in which you are invoking Javalents' plugins. - -## Enforcement - -If you witness or experience any abusive, harassing or otherwise unacceptable behavior in our community, report it to the community leaders responsible for enforcement of [#Javalent-Support-Thread](https://discord.com/channels/686053708261228577/932707309195493416). You may message LittleMaelstrom#6794 or javalent#3452. If we're unavailable, you may also notify sklore#8618. - -The community leaders will promptly and fairly review and investigate all complaints. - -We take all reports of Code of Conduct violations seriously, -and community leaders respect the privacy and security of reporters, no matter the incident. - -### Enforcement Guidelines - -When determining the consequences of any action that violates this Code of Conduct, community leaders will follow these Community Impact Guidelines: - -#### Correction -**Community Impact**: Use inappropriate language or other behavior deemed intentionally inflammatory or unwelcome in the community. - -**Consequence**: Community leaders issue a private, written warning and provides clarity around the nature of the violation, and an explanation of why the behavior is inappropriate. They may request a public apology sometimes. - -#### Warning -**Community Impact**: A violation through a single incident or series - of actions. - -**Result**: A written warning from community leaders, with clear -expectations for behavior going forward. Continued violation of the Code of Conduct may result in further consequences, including temporary or permanent bans. - -#### Temporary Ban -**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. Seriously, you need to keep intentionally violating the CoC to get here. - -**Result**: A temporary ban from participating in any community activities or public communication with the community for a specified period. This includes avoiding interactions in community spaces as well as external channels like #Javalent-Support-Thread in Discord. Violating these terms may lead to a permanent ban. - -#### Permanent Ban -**Community Impact**: Demonstrating a pattern of disregarding community standards, including sustained inappropriate behavior, harassment or aggression toward or disparagement of individuals. At this point, you're absolutely showing disregard for any social decorum to get here. - -**Result**: A permanent ban from participating in any community activities or public interaction with the community. This includes avoiding interactions in community spaces as well as external channels like #Javalent-Support-Thread in Discord. - -## Attributions - -This Code of Conduct is modified from the [Contributor Covenant](https://contributor-covenant.org/), version -[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and -[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), -and was originally generated by [contributing-gen](https://github.com/bttger/contributing-gen) before being edited further. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8524fa2..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,187 +0,0 @@ - -# Contributing to a Javalent Plugin - -First off, thanks for taking the time to contribute. ❤️ - -We encourage and value all types of contributions. -You can find different ways -to help and details about how this project handles them in the **[Table of Contents](CONTRIBUTING.md#table-of-contents)**. -Make sure to read the relevant section before making your contribution. -This will help us maintainers and make the experience smoother for everyone involved. -Your PR helps us help you. 🎉. - -> If you like the project but do not have the time to contribute, here are other ways to show your support and appreciation that we would be happy about: -> - Star the project -> - Spread the word and tell others about it -> - Mention the project in your own projects readme -> - Continue using the project and give us feedback - -## Important Links for Markdown Attributes - -- **[Documentation](https://plugins.javalent.com/attributes)** -- **[Submit an Issue](https://github.com/javalent/markdown-attributes/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)** -- **[Bug Tracker](https://github.com/javalent/markdown-attributes/issues?q=is%3Aopen+label%3Abug+sort%3Aupdated-desc)** -- **[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)** - - -## Table of Contents - -- **[Code of Conduct](CONTRIBUTING.md#code-of-conduct)** -- **[I've a Question](CONTRIBUTING.md#ive-a-question)** -- **[I Want To Contribute](CONTRIBUTING.md#i-want-to-contribute)** -- **[Reporting Bugs](CONTRIBUTING.md#reporting-bugs)** -- **[Suggesting Enhancements](CONTRIBUTING.md#suggesting-features)** -- **[Your First Code Contribution](CONTRIBUTING.md#your-first-code-contribution)** -- **[Improving The Documentation](CONTRIBUTING.md#improving-the-documentation)** -- **[Styleguide](CONTRIBUTING.md#styleguide)** -- **[Commit Messages](CONTRIBUTING.md#commit-messages)** -- **[Join The Project Team](CONTRIBUTING.md#join-the-project-team)** - - -## Code of Conduct - -The Code of Conduct **[governs these project and everyone participating in it](CODE_OF_CONDUCT.md)**. -By participating, the assumption is that you are agreeing to uphold this code. - -## I've a Question - -> If you want to ask a question, we assume that you have read the documentation linked above. - -Before you ask a question, -it is best to search for existing Issues that might help you. -For when you have found a suitable issue and still need clarification, you can write your question in this issue. -It is also advisable to search the internet for answers first. - -If you then still feel the need to ask a question and need clarification, we recommend the following: - -- Open an Issue. -- Code your issue appropriately with one of the four labels. When in doubt, use 'bug'. -- Provide as much context as you can about what you are running into. - -We will then take care of the issue as soon as possible. - -## I Want To Contribute - -> ### Legal Notice -> When contributing to this project, you agree that you have authored 100% of the content, that you have the necessary rights to the content and that you provide the content you contribute under the project licence. - -### Reporting Bugs - - -#### Before Submitting a Bug Report - -A good bug report shouldn't leave others needing to chase you up for more information. -Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. -Complete the following steps in advance to help us fix any potential bug as fast as possible. - -- Make sure that you are using the latest version of Obsidian, including which your installer version is 1.2.7 or newer. -- Determine if your bug is a bug and not an error on your side, for example, using incompatible environment components/versions or have plugin interactions (Make sure that you have read the documentation linked above). If you are looking for support, you might want to check **[this section](CONTRIBUTING.md#ive-a-question)**. -- To see if other users have experienced (and potentially already solved)** the same issue you are having, check for a bug report existing for your bug or error in the bug tracker. -- Also make sure to search the internet (including Obsidian Discord) to see if users outside the GitHub community have discussed the issue. -- Collect information about the bug: -- Error Codes (Traceback) -- OS, Platform and Version (Windows, Linux, macOS, x86, ARM) -- Version of the Obsidian, version of the plugin, how you installed it, your other plugins and what else you think seems relevant. -- Possibly a copy of your `note.md` and possibly the plugins `data.json` file. -- Can you reliably reproduce the issue? - - -#### How Do I Submit a Good Bug Report? - -We use GitHub issues to track bugs and errors. If you run into an issue with the project: - -- Open a GitHub Issue (link at top) and select the Bug Template. -- Explain the expected behavior and the actual behavior. -- Provide as much context as possible, including reproduction steps that someone else can follow to recreate the issue on their own. This should include your code, and for better bug reports, isolate the problem and create a reduced test case. -- Include any relevant information you collected previously. -- Answer all questions on the issue template as accurately as possible. - -After submitting your bug report, our team will take the following steps: - -- Label the issue according to its severity. -- Attempt to reproduce the issue using the steps provided. If we cannot reproduce the issue, we may ask you for additional information and mark the issue as “discovery”. -- If in triage we reproduce the issue, we will categorize it by importance where the issue will wait for **[someone](#your-first-code-contribution)** to implement the solution. - - -### Suggesting Features - -This section guides you through submitting an enhancement suggestion for this Javalent Plugin, -**including completely new features and minor improvements to existing functionality**. -Following these guidelines will help maintainers, -and the community is to understand your suggestion and find related suggestions. - - -#### Before Submitting an Enhancement - -- Make sure that you are using the latest version of Obsidian and that your installer version is 1.2.5 or newer. -- Read the documentation linked above carefully and find out if an existing function already covers the need, maybe by an individual configuration. -- Perform a search in GitHub issues to see if this idea has already suggested the enhancement. If it has, add a comment to the existing issue instead of opening a new one. -- Additionally, find out whether your idea fits with the scope and aims of the project. It is up to you to make a strong case to convince the project's developers the merits of this feature. Keep in mind that we want features that will be useful to most of our users and not a small subset. If you are targeting a few users, consider writing an add-on/plugin library to be added in. - - -#### How Do I Submit a Good Enhancement Suggestion? - -Github Issues logs all of our feature requests. - -- Ensure that the issue title is clear and descriptive, accurately reflecting the suggestion being made. -- Provide a detailed step-by-step description of the suggested enhancement, including as much relevant information as possible. -- State the current behavior, and explain what behavior you expected to see instead and why. You may also wish to mention any alternatives that you considered. -- Consider including screenshots or animated GIFs to demonstrate the steps or highlight the relevant part of the project. Tools such as LiceCap (for macOS and Windows) or Silentcast and Byzanz (for Linux) may be helpful. (Note: this only applies if you are interacting with a GUI, not a CLI.) -- Explain how the suggested enhancement would benefit most plugin users. You may also want to provide examples of other projects that have successfully implemented similar features for inspiration. - - -### Your First Code Contribution - -#### Building the Project - -##### Building from Source - -Once you have installed your desired plugin, you can use `npm` to build new `main.js` and `styles.css` files from the source: - -1. Open your terminal and navigate to the `source directory`, then run `npm install`. -2. Trigger `npm run build` to generate the `main.js` and `styles.css` files inside the `source directory`. -3. Go to the appropriate `javalent-plugin` folder located in your vault's plugins directory, and replace the existing `main.js` and `styles.css` files with the newly generated ones. -4. To start using the new files, reload Obsidian. - 4.a. If you have the **[Hot-Reload](https://github.com/pjeby/hot-reload)** Obsidian plugin installed, - Hot Reload will automate the reload process for you. - -#### Building from .env - -Alternatively, you can use the `npm run dev` command for a more streamlined workflow after setting up your `.env` file: - -1. Create a file called .env in the source directory. -2. Add the following line to the file: `OUTDIR="/absolute/path/to/your/vault/.obsidian/plugins/plugin-name"`. For example, we would use `OUTDIR="/absolute/path/to/your/vault/.obsidian/plugins/fantasy-calendar"` if we're working on the Fantasy Calendar plugin. -3. Run npm run dev in the source directory to build the `main.js` and `styles.css` files, and place them in the folder you specified in your `.env` file. -4. Whenever you save changes, the dev script will automatically rebuild those files. - -### Improving The Documentation - -- Do you see any areas of documentation that seem confusing or unclear? -- Do you see a section that you want to expand on? -- Do you want to add a funny note, a song or a sarcastic vibe? - -Create a GitHub Issue in the appropriate documentation repository stating what you think should change. - -If you are creating an Issue on how you would like to contribute, include two short sample paragraphs of your writing. - -- **1st Sample**: *Narrative/Storytelling Writing*. Much of the documentation mixes between using metaphor and analogy to explain concepts that would otherwise not qualify as beginner-friendly. -- **2nd Sample**: *Technical Writing*. In certain cases, we do revert to Technical Writing for formalized and micromanaged instruction. When writing in this way, anyone can perform these steps and reach the result. - -Both can be freestyle. It could at first be a storytelling guide about how to cook, and then a technical recipe about making a good sandwich. Have fun with it. These samples aren't a test or to judge, but an ***introduction to you***. We will never say no to help. - -## Styleguide - -### Commit Messages - -This repository uses Semver style commit messages, specifically from **[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)**. -This requirement exists to **faciliate automated versioning and changelog generation**. -We do not expect perfection, but do your best to get comfortable with these conventions if you are not familiar with them. - -## Join The Project Team - -Want to officially join the project? Message javalent#3452 on Discord. - - -## Attribution - -We generated this guide using [contributing-gen](https://github.com/bttger/contributing-gen) and further edited it with the help of @Sigrunixia and @Javalent.