Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/linter vue3 #1871

Merged
merged 2 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 17 additions & 21 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,28 @@ If you see someone who is making an extra effort to ensure our community is welc

The following behaviors are expected and requested of all community members:

* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
- Exercise consideration and respect in your speech and actions.
- Attempt collaboration before conflict.
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.

## 4. Unacceptable Behavior

The following behaviors are considered harassment and are unacceptable within our community:

* Violence, threats of violence or violent language directed against another person.
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
* Posting or displaying sexually explicit or violent material.
* Posting or threatening to post other people’s personally identifying information ("doxing").
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
* Inappropriate photography or recording.
* Inappropriate physical contact. You should have someone’s consent before touching them.
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
* Deliberate intimidation, stalking or following (online or in person).
* Advocating for, or encouraging, any of the above behavior.
* Sustained disruption of community events, including talks and presentations.
- Violence, threats of violence or violent language directed against another person.
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
- Posting or displaying sexually explicit or violent material.
- Posting or threatening to post other people’s personally identifying information ("doxing").
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
- Inappropriate photography or recording.
- Inappropriate physical contact. You should have someone’s consent before touching them.
- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
- Deliberate intimidation, stalking or following (online or in person).
- Advocating for, or encouraging, any of the above behavior.
- Sustained disruption of community events, including talks and presentations.

## 5. Consequences of Unacceptable Behavior

Expand All @@ -55,16 +55,12 @@ If a community member engages in unacceptable behavior, the community organizers

If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected].



Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.

## 7. Addressing Grievances

If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify Witnet Foundation with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.



## 8. Scope

We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
Expand Down
86 changes: 40 additions & 46 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,15 @@

:tada: Thank you for being interested in contributing to Sheikah! :tada:

The following is a set of guidelines and helpful pointers for contributing to Sheikah.
The keyword here is guidelines, not rules. As such, use your best judgement and feel free to propose changes to even this document.
The following is a set of guidelines and helpful pointers for contributing to Sheikah. The keyword here is guidelines, not rules. As such, use your best judgement and feel free to propose changes to even this document.

## Code of conduct

Everyone participating in this project is governed by the [Witnet Code of Conduct][code].
By participating, you are expected to uphold this code as well.
Everyone participating in this project is governed by the [Witnet Code of Conduct][code]. By participating, you are expected to uphold this code as well.

## I just have a question

Please don't file an issue with questions.
It's easier for you and for us if you go directly to [discord server][discord], since it will keep our repositories clean and you will get a faster response.
Please don't file an issue with questions. It's easier for you and for us if you go directly to [discord server][discord], since it will keep our repositories clean and you will get a faster response.

## How can I contribute?

Expand All @@ -29,81 +26,78 @@ Bugs are tracked as [GitHub issues][issues].

Explain the problem and include additional details to help maintainers reproduce the problem:

* Use a clear and descriptive title for the issue to identify the problem.
* Describe the exact steps which reproduce the problem in as many details as possible.
* Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
* Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
* Explain which behavior you expected to see instead and why.
* Post a screenshot or a dump of the developer console
* If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Post a screenshot or a dump of the developer console
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

* Did the problem start happening recently (e.g. after updating to a new version) or was this always a problem?
* If the problem started happening recently, can you reproduce the problem in an older version of Sheikah? What's the most recent version in which the problem doesn't happen?
* Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
- Did the problem start happening recently (e.g. after updating to a new version) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Sheikah? What's the most recent version in which the problem doesn't happen?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

* Which version of Node are you using? You can get the exact version by running node -v in your terminal.
* What's your operating system and version?
- Which version of Node are you using? You can get the exact version by running node -v in your terminal.
- What's your operating system and version?

## Suggesting enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
Following these guidelines helps maintainers and the community understand your suggestion.
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion.

Before creating enhancement suggestions, please double check that there is not already an existing feature suggestion for your feature, as you might find out that you don't need to create one.
When you are creating an enhancement suggestion, please include as many details as possible.
Before creating enhancement suggestions, please double check that there is not already an existing feature suggestion for your feature, as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

### How Do I Submit A Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:

* Use a clear and descriptive title for the issue to identify the suggestion.
* Provide a step-by-step description of the suggested enhancement in as many details as possible.
* Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
* Describe the current behavior and explain which behavior you expected to see instead and why.
* Explain why this enhancement would be useful to most users and isn't something that can or should be implemented as a community package.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most users and isn't something that can or should be implemented as a community package.

## Pull Requests

* Do not include issue numbers in the PR title
* Follow [our styleguide][styleguide]
* Avoid platform-dependent code
* Place imports in the following order:
* External Node modules, referred by package name (such as `os` or `path`)
* Local Modules, using relative paths
- Do not include issue numbers in the PR title
- Follow [our styleguide][styleguide]
- Avoid platform-dependent code
- Place imports in the following order:
- External Node modules, referred by package name (such as `os` or `path`)
- Local Modules, using relative paths

## Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these good first issue issues:

* [Good first issue][first-issue] - issues which should only require a few lines of code, and a test or two.
- [Good first issue][first-issue] - issues which should only require a few lines of code, and a test or two.

## Styleguides

### Commits

* Use the infinitive mood:
* "Add feature", not "Added feature"
* "Move cursor to..." not "Moves cursor to..."
* Try to make the first line of your commit message be around 50 characters long
* Trim all lines in your commit message to 72 characters
* Do not include issue numbers in the first line of your commit message
* Reference issues and pull requests liberally after the first line
* [Verify your commits][signing-commits] before creating a pull request
* Standardize your commits:
Good commit messages are: `feat(ui-compo): implement button component` or `test(button): fix button behavior`
- Use the infinitive mood:
- "Add feature", not "Added feature"
- "Move cursor to..." not "Moves cursor to..."
- Try to make the first line of your commit message be around 50 characters long
- Trim all lines in your commit message to 72 characters
- Do not include issue numbers in the first line of your commit message
- Reference issues and pull requests liberally after the first line
- [Verify your commits][signing-commits] before creating a pull request
- Standardize your commits: Good commit messages are: `feat(ui-compo): implement button component` or `test(button): fix button behavior`

A good rule of thumb is that your commit message follows these rules if you can prefix it with "This commit will ..." and it makes sense.
For example, "This commit will add a feature" vs "This commit will added a feature".
A good rule of thumb is that your commit message follows these rules if you can prefix it with "This commit will ..." and it makes sense. For example, "This commit will add a feature" vs "This commit will added a feature".

### Javascript

All TypeScript must adhere to [our Javascript styleguide][styleguide].

## Copyright

These guidelines are based on the [AragonJS contributing guidelines][aragonjs], published under the [Creative Commons Zero v1.0 Universal License][CC0].

[discord]: https://discord.gg/FDPPv7H
Expand Down
33 changes: 15 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
---
name: Bug report
about: Create a report to help Sheikah improve

---

**Describe the bug**
A clear and concise description of what the bug is.
**Describe the bug** A clear and concise description of what the bug is.

**To Reproduce** Steps to reproduce the behavior:

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
**Expected behavior** A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Screenshots** If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context** Add any other context about the problem here.
13 changes: 4 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
---
name: Feature request
about: Suggest an idea for Sheikah

---

**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 [...]
**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 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.
**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
**Additional context** Add any other context or screenshots about the feature request here.
9 changes: 3 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@

Thank you for contributing to sheikah! :)

**Please fill in this template (by putting an `x` inside
the brackets) _before_ filing your PR:**
**Please fill in this template (by putting an `x` inside the brackets) _before_ filing your PR:**

- [ ] I have read and understood [CODE_OF_CONDUCT][code] document.
- [ ] I have read and understood [CONTRIBUTING][cont] document.
- [ ] I have read and understood [STYLEGUIDE][style] document.
- [ ] I have included tests for the changes in my PR. If not, I have included a
rationale for why I haven't.
- [ ] I have included tests for the changes in my PR. If not, I have included a rationale for why I haven't.
- [ ] My code is formatted and is accepted by `yarn lint`.
- [ ] **I understand my PR may be closed if it becomes obvious I didn't
actually perform all of these steps.**
- [ ] **I understand my PR may be closed if it becomes obvious I didn't actually perform all of these steps.**

# Why this change is necessary and useful

Expand Down
1 change: 0 additions & 1 deletion .stylelintignore

This file was deleted.

18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@ Go to [releases](https://github.com/witnet/sheikah/releases) section and downloa

This is a Web/Desktop application built with [Electron](https://electronjs.org/). When developing Sheikah, we support **Node CURRENT and LTS+**. It might work with another version but we do not guarantee it will do in the future.


### Running Sheikah

``` bash
```bash
# clone the repository
git clone [email protected]:witnet/sheikah.git

Expand All @@ -44,14 +43,14 @@ yarn electron:serve:wallet

### Formatter

* Verify files are correctly formatted with `yarn lint`
* Repair lint errors with (**this operation modifies your files!**) `yarn lint!`
- Verify files are correctly formatted with `yarn lint`
- Repair lint errors with (**this operation modifies your files!**) `yarn lint!`

### Test

We use [Jest](https://facebook.github.io/jest/) for testing.

``` bash
```bash
# run unit tests
yarn test
```
Expand All @@ -72,11 +71,12 @@ When opening a pull request a job in [Github Actions](https://github.com/feature

#### Troubleshooting

* Use `yarn clean` to remove the contents of the build directory (`dist_electron`)
* Use `yarn clean-deps` to remove all installed dependencies
* Use `yarn reinstall` to remove all installed dependencies and install them again
- Use `yarn clean` to remove the contents of the build directory (`dist_electron`)
- Use `yarn clean-deps` to remove all installed dependencies
- Use `yarn reinstall` to remove all installed dependencies and install them again

If the application doesn't boot correctly and no error is reported in the terminal, try running `yarn reinstall` and try again.

## Release
Releases are created using [action-electron-builder](https://github.com/samuelmeuli/action-electron-builder). A new draft release will be publish naming a commit and a tag as v*.*.*

Releases are created using [action-electron-builder](https://github.com/samuelmeuli/action-electron-builder). A new draft release will be publish naming a commit and a tag as v*.*.\*
4 changes: 1 addition & 3 deletions auto-imports.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@
// noinspection JSUnusedGlobalSymbols
// Generated by unplugin-auto-import
export {}
declare global {

}
declare global {}
Loading
Loading