Documentation about our development process #82
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e style, setup and README
* feat(global): add biome as linter (in place of eslint) and formatter * feat(monorepo): remove vscode settings from source control * feat(monorepo): change biome formatter indent width to 4
* feat: init - instantiate canvas boilerplate - add xml queries to read LDType from .scd * feat: add primitive bay node design * feat: add control buttons and remaining search queries (dirty version) - add remaining search queries, their wrappers and types - complete the prototype version of showing all variations of types available - add buttons to add new types (inactive) - small refactor of bay component * perf(ce): Limit GSEControl querry to parent (#51) * perf: Limit GSEControl querry to parent * perf: Search in correct IED for control * feat: correctly show fetched nodes * fix: show props only if value exists * feat: write to SCD: v.0.1 * feat(ce): increment version to trigger github action (#77) * deploy: fix actions triggers (#79) * deploy: test actions trigger * deploy: increment communication explorer plugin version for test purpose * deploy: reverse version increment on communication explorer plugin as test is done * deploy: change paths that triggers the actions to reflect the monorepo tree * fix: correctly pass event to its dispatcher * fix: typo in variable name * Deploy: fix github actions authentication (#81) * deploy: test actions trigger * deploy: increment communication explorer plugin version for test purpose * deploy: reverse version increment on communication explorer plugin as test is done * deploy: change paths that triggers the actions to reflect the monorepo tree * deploy: change the way action script is pushing to the gh-pages branch as per the docs * deploy: increment communication explorer plugin version for test purpose * deploy: change the fit push command on build.yml to use the GITHUB_TOKEN * deploy: increment communication explorer plugin version for test purpose * deploy: comment out secrets in build:yml * deploy: increment communication explorer plugin version for test purpose * deploy: comment out secrets in plugin_communication-explorer.yml * deploy: increment communication explorer plugin version for test purpose * deploy: reverse version increment on communication explorer plugin as test is done * deploy: remove all personal token references in favor of the GITHUB_TOKEN * deploy: remove the trigger for this specific branch * feat: events setup - auto update doc on important changes * feat: correct nodes options * feat: node component * feat: small clean-up * feat: complete event list - full functionality * feat: add primitive node configuration * fix: re-add deleted searchLNodeTypes * fix: correct event receiving model * feat: clean-up * fix: update todo * feat: real-time doc update on createNode + fix wrong names in scd * chore: clean-up * chore: clean-up * feat(type-designer): rework of the plugin I reworked this draft to allow myself to enter both in svelte and the project. I simplified the business logic which I transferred to the core package (separate PR). * Structure convention on Core (#85) * feat(type-designer): rewrite of the typedesigner logic + new structure convention New structure convention can be found as ADR 0004 It is used here for the implementation of the new type designer logic Some unused files have been moved to a specific folder waiting approval before deletion * feat(adr): add more precisions to the adr * Add biome as linter (in place of eslint) and formatter (#86) * feat(global): add biome as linter (in place of eslint) and formatter * feat(monorepo): remove vscode settings from source control * feat(monorepo): change biome formatter indent width to 4 * feat: init - instantiate canvas boilerplate - add xml queries to read LDType from .scd * feat: add primitive bay node design * feat: add control buttons and remaining search queries (dirty version) - add remaining search queries, their wrappers and types - complete the prototype version of showing all variations of types available - add buttons to add new types (inactive) - small refactor of bay component * feat: correctly show fetched nodes * fix: show props only if value exists * feat: write to SCD: v.0.1 * fix: correctly pass event to its dispatcher * fix: typo in variable name * feat: events setup - auto update doc on important changes * feat: correct nodes options * feat: node component * feat: small clean-up * feat: complete event list - full functionality * feat: add primitive node configuration * fix: re-add deleted searchLNodeTypes * fix: correct event receiving model * feat: clean-up * fix: update todo * feat: real-time doc update on createNode + fix wrong names in scd * chore: clean-up * chore: clean-up * feat(type-designer): rework of the plugin I reworked this draft to allow myself to enter both in svelte and the project. I simplified the business logic which I transferred to the core package (separate PR). * Structure convention on Core (#85) * feat(type-designer): rewrite of the typedesigner logic + new structure convention New structure convention can be found as ADR 0004 It is used here for the implementation of the new type designer logic Some unused files have been moved to a specific folder waiting approval before deletion * feat(adr): add more precisions to the adr * feat(type-designer): change minor things after review + biome formatting core and type designer --------- Co-authored-by: Illia Solovei <[email protected]> Co-authored-by: Christopher Lepski <[email protected]> Co-authored-by: Michel Guerin <[email protected]> Co-authored-by: Michel Guerin <[email protected]>
…e style, setup and README
trusz
reviewed
Oct 10, 2024
| @@ -0,0 +1,132 @@ | |||
| # Contributor Covenant Code of Conduct | |||
There was a problem hiding this comment.
I think we should discuss this in the team and see if it is compatible with the project.
There was a problem hiding this comment.
This PR is a proposition for these Open Source project base files ;)
doc/guidelines/dev_process.md
Outdated
| ## Sprint Backlog | ||
|
|
||
| * When you are assigned to an issue from the Sprint Backlog, please do the following: | ||
| * Create a ney branch following the |
There was a problem hiding this comment.
The rest of the sentence is missing :)
There was a problem hiding this comment.
Ah oups ! I made a proposition for a simple branch naming convention.
| * On MacOS: `brew install node@20` | ||
| * Package manager [pnpm](https://pnpm.io/) | ||
| * On MacOS: `brew install pnpm` | ||
| * Enable corepack afterwards : `sudo corepack enable` |
There was a problem hiding this comment.
I believe if you have node, you don't have to install pnpm just enable the corepack
Comment on lines
+27
to
+28
| * Mural Read-Access |
There was a problem hiding this comment.
These are internal tools. If external developers want to contribute we will find another way. I don't think we need Mural for development, everything that is necessary for the development should be part of the issue.
…d-plugins into feat(doc)/add_dev_process
rdsov
reviewed
Oct 10, 2024
|
|
||
| ## Version control management practice | ||
|
|
||
| We are following the [trunk-based development rules](https://trunkbaseddevelopment.com/) : one trunk (main), short life feature branches that should not live longer than a sprint. |
There was a problem hiding this comment.
short-lived instead of short life :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add new content to the documentation as we discuss earlier @trusz (styling, dev process)
Some parts are more based on my intuition of how things already work in the project (trunk base, conventional commit).
We did not discuss it in the team. If it's outside the scope, we can take it out for now.