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.

Sign up for GitHub

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

Jump to bottom

(Docs) Add docs how to setup dev environment #20

Open
4 tasks
mishushakov opened this issue Oct 12, 2022 · 13 comments · May be fixed by #217
Open
4 tasks

(Docs) Add docs how to setup dev environment #20

mishushakov opened this issue Oct 12, 2022 · 13 comments · May be fixed by #217
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@mishushakov
Copy link
Member

mishushakov commented Oct 12, 2022 •
edited

We will want to tell users how to setup dev environment to work on Step CI codebase. For that we would need an extra section in our readme, which would contain the following:

  • List dependencies like Node, NPM, etc.
  • How to install them
  • How to test the code
  • How to run the build
@mishushakov mishushakov added help wanted Extra attention is needed documentation Improvements or additions to documentation labels Oct 12, 2022
@Anuran12
Copy link

@mishushakov I would like to work on this .. but i don't know how to explain those 4 poins. if you guide me then i can do that

@mishushakov
Copy link
Member Author

Awesome! You can use these for inspiration: 1, 2

You can see our npm scripts here:

stepci/package.json

Lines 23 to 27 in 1b6a479

"scripts": {
"build": "tsc -p tsconfig.json",
"build:watch": "tsc -w -p tsconfig.json",
"test": "ts-node ./src/index.ts run examples/status.yml"
},

@Anuran12
Copy link

okay I am trying...

@Anuran12
Copy link

under Prerequisites i have to add node and npm right ?

@mishushakov
Copy link
Member Author

yep!

@Anuran12
Copy link

image

Is it going well ?

@Anuran12
Copy link

@mishushakov but what should i write next ?

@Anuran12
Copy link

@mishushakov Heyyy....

@mishushakov
Copy link
Member Author

Hello, sorry for leaving you behind 🙏
Could you please open a draft pull request so we could work on it together? I would be able to review on the weekend

Thanks

@Anuran12
Copy link

Hello, sorry for leaving you behind 🙏
Could you please open a draft pull request so we could work on it together? I would be able to review on the weekend

Thanks

Yea sure... It's a good Idea.

By the way, basically i work on frontend development. So if your website needs any frontend work please let me know.

Thanks 🫶

@Anuran12 Anuran12 mentioned this issue Oct 14, 2022
Closed
@Anuran12
Copy link

@mishushakov I created a Pull Request.

@sebastianwis
Copy link
Contributor

Hey @Anuran12
Thank you once again for your contribution here!
It would be amazing to welcome you to our Discord if you haven't joined it yet:
https://discord.com/invite/KqJJzJ3BTu
This is where we keep users up to date with updates, features and bug resolutions.

@vaibhav135 vaibhav135 linked a pull request May 4, 2024 that will close this issue
Draft
@vaibhav135
Copy link

@mishushakov raised a PR please check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(Docs) Added CONTRIBUTING.md vaibhav135/stepci
4 participants
@mishushakov @vaibhav135 @Anuran12 @sebastianwis