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

Update copyright, documentation and blogpost links #5462

Merged
merged 4 commits into from
Nov 17, 2023
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ See [contributors section](https://github.com/LiskHQ/lisk-desktop/graphs/contrib

## License

Copyright © 2016-2023 Lisk Foundation
Copyright © 2016-2024 Lisk Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Expand Down
4 changes: 2 additions & 2 deletions docs/CSS_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
1. Define class names in camel-case.
2. For the styling purpose, prefer class names to IDs.
3. Prefer defining variables for all CSS values describing a certain presentational behaviour and used in multiple places (We use ‘css-next’ variables. Read [this](http://cssnext.io/features/#custom-properties-var) for more information).
3. Prefer defining variables for all CSS values describing a certain presentational behavior and used in multiple places (We use ‘css-next’ variables. Read [this](http://cssnext.io/features/#custom-properties-var) for more information).
4. There is common css file in app component and if you use a class Name in more than one components, Add it to this file (don’t use this for child and depend components).
5. Vendor prefixes are not needed since autoprefixer performs this. Read [docs](https://github.com/postcss/autoprefixer) for more information.
6. Please ensure cross browser compatibility for all major browsers.
7. Use ‘:global’ before any global classes because we use css modules and it adds a hash to non global class names.
8. SVG is the preferred format for all the images.
9. Avoid storing images in directories other than [src/assets/images](/src/assets/images).
9. Avoid storing images in directories other than [setup/react/assets/images](/setup/react/assets/images).
10. Try restricting CSS nesting feature to no more than three levels.
11. Flexbox is the exploited layout and hence it’s preferred project wide (check [docs](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) for more information).
12. Use kebab-case for naming the assets.
Expand Down
2 changes: 0 additions & 2 deletions docs/DEVELOPMENT_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ This is a live document, please expect updates and unfinished content.
1. [How Can I Contribute?](CONTRIBUTING_GUIDE.md)
1. [React](REACT_GUIDE.md)
1. [PostCSS](CSS_GUIDE.md)
1. [Testing](TEST_GUIDE.md)
1. [Epic Specification](EPIC_SPECIFICATION_GUIDE.md)
1. [Lisk URL Protocols](PROTOCOL_GUIDE.md)

## Code of Conduct

Expand Down
8 changes: 2 additions & 6 deletions docs/EPIC_SPECIFICATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# Lisk Desktop Epic Specificaiton Guideline
# Lisk Desktop Epic Specification Guideline

Lisk Desktop team will gather community enhancement proposals in the backlog of the project.

Once a substantial ammount of proposals have been identified as belonging to the same type/category of enhancemnt, an epic will be created to handle the development journey towards it's implementation.
Once a substantial amount of proposals have been identified as belonging to the same type/category of enhancement, an epic will be created to handle the development journey towards it's implementation.

## Table Of Contents

1. [Requirements](#requirements)
1. [Epic creation best practices](#epic-creation-best-practices)
1. [Epic workflow](#epic-workflow)

## Requirements

Install [ZenHub](https://www.zenhub.com/) browser extension to your browser (Chrome and Firefox supported) to be able to access the Epic feature of ZenHub in Github

## Epic creation best practices

Please ensure you follow this practices when creating or working in an epic.
Expand Down
4 changes: 3 additions & 1 deletion docs/HARDWARE_WALLET_DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# How to use the Ledger hardware wallet
# How to use the Ledger hardware wallet (Dev Mode)

Note: This guide is only for development purpose, for production usage please download the Lisk App from Ledger Live.

## Step 1: Manually add the Lisk ledger app to your Ledger hardware wallet

Expand Down
1 change: 0 additions & 1 deletion docs/PR-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

- The PR has an issue.
- All conflicts are resolved.
- The PR follows our [Test guide](/docs/TEST_GUIDE.md).
- The PR follows our [CSS guide](/docs/CSS_GUIDE.md).

When you're done, submit a pull request and one of the maintainers will check it out. You will be informed if there are any problems or changes that may need to be considered.
Expand Down
47 changes: 0 additions & 47 deletions docs/PROTOCOL_GUIDE.md

This file was deleted.

161 changes: 0 additions & 161 deletions docs/TEST_GUIDE.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/modules/legacy/components/AccountsComparison/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const AccountsComparison = ({ t }) => {
className={`${styles.link} link`}
onClick={() => {
window.open(
'https://lisk.com/blog/development/actions-required-upcoming-mainnet-migration#MigrateanunitiliazedAccount',
'https://lisk.com/blog/posts/reclaiming-a-lisk-account',
'_blank',
'rel=noopener noreferrer'
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ describe('Reclaim balance screen', () => {
wrapper.find('.link').at(0).simulate('click');
expect(window.open).toHaveBeenNthCalledWith(
1,
'https://lisk.com/blog/development/actions-required-upcoming-mainnet-migration#MigrateanunitiliazedAccount',
'https://lisk.com/blog/posts/reclaiming-a-lisk-account',
'_blank',
'rel=noopener noreferrer'
);
Expand Down
2 changes: 1 addition & 1 deletion src/modules/legacy/components/Introduction/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const Introduction = ({ t, nextStep }) => (
className={styles.link}
onClick={() => {
window.open(
'https://lisk.com/blog/development/actions-required-upcoming-mainnet-migration',
'https://lisk.com/blog/posts/announcing-lisk-mainnet-v4-migration',
'_blank',
'rel=noopener noreferrer'
);
Expand Down
2 changes: 1 addition & 1 deletion src/modules/legacy/components/Introduction/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('Reclaim balance Introduction screen', () => {
const wrapper = mount(<Introduction {...props} />);
wrapper.find('.link').first().simulate('click');
expect(window.open).toHaveBeenCalledWith(
'https://lisk.com/blog/development/actions-required-upcoming-mainnet-migration',
'https://lisk.com/blog/posts/announcing-lisk-mainnet-v4-migration',
'_blank',
'rel=noopener noreferrer'
);
Expand Down