Add CONTRIBUTING.md #246
Add CONTRIBUTING.md #246
Conversation
| npm install -g pkg | ||
| workdir: /projects/chectl | ||
|
|
||
| - name: Package Binaries |
There was a problem hiding this comment.
just to know, it's the deprecated binaries
it's oclif-dev pack now
There was a problem hiding this comment.
Thanks. I will try
There was a problem hiding this comment.
oclif-dev pack does not create executable file. It creates a package, which contains node with a set of javascript files.
devfile.yaml
Outdated
| ./run --help | ||
| workdir: /projects/chectl/bin | ||
|
|
||
| - name: Install Packager |
There was a problem hiding this comment.
not required anymore (only for deprecated binaries)
There was a problem hiding this comment.
I have removed this command and updated a command to build packaged.
I will update it when it become clean how to use oclif-dev pack.
CONTRIBUTING.md
Outdated
| ## Create workspace, clone sources | ||
|
|
||
| To create a workpace you can use [devfile](devfile.yaml). | ||
| For that you have to [install the latest version](https://www.eclipse.org/che/docs/che-7/che-quick-starts.html#installing-the-chectl-management-tool) of this chectl and create a workspace: |
There was a problem hiding this comment.
it looks odd to install chectl when we clone chectl ?
There was a problem hiding this comment.
Yes and no. It's ok if we are explaining the user steps to create a workspace.
From other side it's extra information as user is already pretty experienced if he is going to contribute to chectl.
There was a problem hiding this comment.
Extra sentence has been removed.
CONTRIBUTING.md
Outdated
|
|
||
| #### 'dev' container | ||
|
|
||
| `chectl` is written on TypeScript. For that this container has preinstalled software to be able to build, test and launch `chectl`. |
There was a problem hiding this comment.
| `chectl` is written on TypeScript. For that this container has preinstalled software to be able to build, test and launch `chectl`. | |
| `chectl` is written in TypeScript. For that this container has preinstalled software to be able to build, test and launch `chectl`. |
CONTRIBUTING.md
Outdated
| - package binaries | ||
| - format sources | ||
|
|
||
| You can run commands in one of tree ways. |
There was a problem hiding this comment.
| You can run commands in one of tree ways. | |
| You can run commands in one of three ways. |
CONTRIBUTING.md
Outdated
|
|
||
| ## Package binaries | ||
|
|
||
| ### Install packager |
There was a problem hiding this comment.
needs to be reworked. It's only using now oclif-dev pack
vitaliy-guliy
requested review from
azatsarynnyy,
l0rd,
rhopp and
vparfonov
as code owners
|
FYI @vitaliy-guliy the semantic checks are failing https://github.com/che-incubator/chectl#providing-pull-request |
I don't understand why. Each commit has signed-off part. |
devfile.yaml
Outdated
| - name: chectl | ||
| source: | ||
| type: git | ||
| location: 'https://github.com/che-incubator/chectl.git' | ||
| location: 'https://github.com/vitaliy-guliy/chectl.git' |
There was a problem hiding this comment.
will be reverted before merging ?
|
@vitaliy-guliy semantic commits check is not Signed commits |
Signed-off-by: Vitaliy Gulyy <vgulyy@redhat.com>
vitaliy-guliy
force-pushed
the
update-devfile
branch
from
235cc60 to
e7f9584
Compare
CONTRIBUTING.md
Outdated
|
|
||
| #### 'theia-dev' container | ||
|
|
||
| This container is used only for running Theia editor and does not take part in the following flow. |
There was a problem hiding this comment.
I'm not sure to understand why we have a container that is not used ?
AFAIK we don't have theia-dev there
There was a problem hiding this comment.
theia-de, not theia-dev. It's my wrong.
CONTRIBUTING.md
Outdated
|
|
||
| ## Package binaries | ||
|
|
||
| For packaging binaries we use https://github.com/oclif/dev-cli. It generates packaged for Linux, Windows and MacOS operation systems and puts the result in `dist/channels/stable` directory. |
There was a problem hiding this comment.
| For packaging binaries we use https://github.com/oclif/dev-cli. It generates packaged for Linux, Windows and MacOS operation systems and puts the result in `dist/channels/stable` directory. | |
| For packaging binaries, [oclif](https://github.com/oclif/dev-cli) is used. It generates packages for Linux, Windows and MacOS operation systems and puts the result in `dist/channels/stable` directory. |
Signed-off-by: Vitaliy Gulyy <vgulyy@redhat.com>
What does this PR do?
Adds
CONTRIBUTING.mdfile describing the development flow.Updates
devfile.yaml.Adds formatter to
package.json.What issues does this PR fix or reference?
eclipse-che/che#14126
Still not working command running in container (need to found a solution):
Before merging the link to
chectlsources in the devfile will be changed to original git repo.