From ca2471300ff817b9b438d741435724ca88e6d063 Mon Sep 17 00:00:00 2001 From: Chen Asraf Date: Thu, 30 Mar 2023 09:46:24 +0300 Subject: [PATCH] docs: README, issue templates, FUNDING.yml --- .editorconfig | 9 +++++ .github/FUNDING.yml | 13 +++++++ .github/ISSUE_TEMPLATE/bug_report.md | 39 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++ .markdownlint.json | 7 +++- .prettierrc | 15 ++++++++ README.md | 45 +++++++++++++++++------ 7 files changed, 140 insertions(+), 12 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .prettierrc diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c1d757f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +[*] +tab_width = 2 +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..bbf3490 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,13 @@ +# These are supported funding model platforms + +github: chenasraf +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: casraf +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: + - 'https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=TSH3C3ABGQM22¤cy_code=ILS&source=url' diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..31763fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug, needs-triage +assignees: chenasraf +--- + +#### Describe the bug + +A clear and concise description of what the bug is. + +#### How To Reproduce + +Steps to reproduce the behavior: + +1. ... +2. ... +3. ... + +#### Expected behavior\*\* + +A clear and concise description of what you expected to happen. + +#### Logs + +If applicable, paste your logs to help explain your problem. To see more logs, run the scaffold with +`-v 1` to enable debug logging. + +#### Desktop (please complete the following information): + +- OS: [e.g. macOS, Windows, Linux] +- OS Version: [e.g. Big Sur, 11, Ubuntu 20.04] +- Broswer Version: [e.g. Chrome 128] +- Extension Version: [e.g. v0.2.3] + +#### Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0d85a66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE] " +labels: enhancement, needs-triage +assignees: chenasraf +--- + +#### Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +#### Describe the solution you'd like + +A clear and concise description of what you want to happen. + +#### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered, if +applicable. + +#### Additional context + +Add any other context or screenshots about the feature request here. diff --git a/.markdownlint.json b/.markdownlint.json index f2a375a..c64b061 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,3 +1,8 @@ { - "MD024": false + "MD024": false, + "line-length": { + "line_length": 100, + "code_blocks": false, + "tables": false + } } diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..548c817 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,15 @@ +{ + "printWidth": 100, + "semi": false, + "singleQuote": true, + "trailingComma": "all", + "overrides": [ + { + "files": "*.md", + "options": { + "printWidth": 100, + "proseWrap": "always" + } + } + ] +} diff --git a/README.md b/README.md index 007e8b3..bdd945d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Current features: build this extension yourself: the extension is open source, and available for peer review or forks. 🕷 Post issues/bugs, questions or feature requests at this link: -https://github.com/chenasraf/fp-max-extension/issues + 👨‍⚖️ This extension is not affiliated with Floatplane, LMG or LTT in any capacity. Use it at your own risk, and if something breaks, complain to me and not to the LMG staff. If you are from @@ -36,14 +36,16 @@ This extension should work on all Chromium-based browsers: ### Direct installation -While Chrome Web Store version is not yet available, you can install directly. See our -[Releases](https://github.com/chenasraf/fp-max-extension/releases/latest) page. +To avoid the Chrome Web Store, you can install directly from zip in developer mode. See our +[Releases](https://github.com/chenasraf/fp-max-extension/releases/latest) page for the download +link. - Download the latest release zip -- Extract the zip - make sure it is 1 folder containing other files, not all the files directly, and - not nested directories -- Drag the directory into your browser's extensions page. Note you must have developer mode enabled - on your browser for this to work +- Extract the zip + > make sure it is 1 folder containing other files, not all the files directly, and not nested + > directories +- Drag the directory into your browser's extensions page. + > Note you must have developer mode enabled on your browser for this to work ## Development @@ -59,12 +61,33 @@ you should be able build this extension yourself. - Clone this repository - Run `npm install` (or `yarn install`) - Run `npm run build` (or `yarn build`) to build the output to the `dist/` folder -- Drag the `dist/` folder to your browser's extensions page. Note you must have developer mode - enabled on your browser for this to work +- Drag the `dist/` folder to your browser's extensions page. + > Note you must have developer mode enabled on your browser for this to work - You should be good to go ### Contributions -I welcome all PRs, ideas, bug reports or other questions or feedback. +## Contributing -Use the [Issues feature](https://github.com/chenasraf/fp-max-extension) to submit your own. +I am developing this package on my free time, so any support, whether code, issues, or just stars is +very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate +just a small amount to help sustain this project, I would be very very thankful! + + + Buy Me a Coffee at ko-fi.com + + +I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature, +don't hesitate to open an appropriate issue and I will do my best to reply promptly. + +If you are a developer and want to contribute code, here are some starting tips: + +1. Fork this repository +2. Run `yarn install` +3. Run `yarn dev` to build dist folder +4. Install the dist folder using the instruction earlier in the readme +5. Make any changes you would like +6. Update the relevant documentation (readme, code comments, type comments) +7. Create a PR on upstream