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

docs rewrite working conventions #26

Merged
merged 5 commits into from
Jan 15, 2024
Merged

Conversation

Ryun1
Copy link
Member

@Ryun1 Ryun1 commented Dec 18, 2023

List of changes

  • Changed documentation to improve intended working conventions

Checklist

  • related issue
  • My changes generate no new warnings
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the changelog
  • [] I have added tests that prove my fix is effective or that my feature works

CONTRIBUTING.md Outdated Show resolved Hide resolved
@Ryun1 Ryun1 linked an issue Dec 18, 2023 that may be closed by this pull request
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
@Ryun1
Copy link
Member Author

Ryun1 commented Jan 10, 2024

While we are here, is there any nice-to-haves/tech debt that people would prefer?
like switching everything to yarn instead of npm

@MSzalowski
Copy link
Contributor

MSzalowski commented Jan 10, 2024

While we are here, is there any nice-to-haves/tech debt that people would prefer? like switching everything to yarn instead of npm

+1 for switching to yarn 💪

Regarding tech debt - we had a meeting with frontend guys and they pointed out:

  1. I18n integration - to avoid strings that are in many places duplicated (and gradually migrate them to some kind of application content storage).
  2. Unification of consts (currently application have checks of types to string eg. https://github.com/IntersectMBO/govtool/blob/f66591ab7156fe80996f5addf2de8356463365f3/src/vva-fe/src/context/wallet.tsx#L337C18-L337C18).
  3. Inline styles and duplicate components if there are any (needs investigation).
  4. Eslint, tsc, husky to have the unified code style and checks on commit.
  5. Wallet refactor - 1.2k of lines seems to be impossible to refactor at once but as it is one of the most crucial parts of the application I think that we should take care of designing the architecture for that module and again - gradually improve that file to increase the readability and maintainability.

Also - @JanJaroszczak provided PR with initial unit tests that are also a good starting point for any other unit tests that might be added to github actions.

What do you think?

@Ryun1 Ryun1 force-pushed the docs/update-working-conventions branch from 3f134f3 to 30ca970 Compare January 11, 2024 16:24
@Ryun1 Ryun1 added the 📜 Documentation Improvements or additions to documentation label Jan 14, 2024
@kickloop kickloop marked this pull request as ready for review January 15, 2024 11:52
@kickloop kickloop merged commit 213f5c2 into main Jan 15, 2024
@Ryun1 Ryun1 deleted the docs/update-working-conventions branch February 21, 2024 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Revise working conventions documentation
6 participants