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

simplify code contributions by fully automating the dev setup. #88

Closed
wants to merge 1 commit into from
Closed

Conversation

nisarhassan12
Copy link

@nisarhassan12 nisarhassan12 commented Feb 24, 2020

Hi! 🙂

This Pr simplifies code contributions by fully automating the dev setup with gitpod(a free online VS Code like ide). With a single click it will launch a ready to code workspace and automatically:

  • clone the self-defined repo.
  • install the dependencies.
  • start npm run serve.

so that anyone interested in contributing to the source code of the site can start away.

You can give a try on my fork of the repo via the link below:

https://gitpod.io/#https://github.com/nisarhassan12/selfdefined

This is how it looks:
image

@tatianamac tatianamac added Status · Hold Something blocks progress Type · DX Affects developer experience labels Feb 25, 2020
@tatianamac
Copy link
Collaborator

Awesome! Thanks for setting this up, @nisarhassan12 ! I also love that you're a first-time contributor to our project! ✨

We're working on a few dev environment things, so I'm going to hold off on reviewing this until those are complete. See #74, which I'll consider a block before we review integrating this.

@nisarhassan12
Copy link
Author

Ok! Thanks :)

@tatianamac
Copy link
Collaborator

@greatislander @ovlb How do you all feel about this simplification to the dev environment?

This was blocked by the other CI updates we were working on.

@tatianamac tatianamac added Status · Needs Review Needs editing/translation/code review and removed Status · Needs Review Needs editing/translation/code review labels Mar 9, 2020
@ovlb
Copy link
Collaborator

ovlb commented Mar 10, 2020

Hey @nisarhassan12! Thanks for taking your time to contribute :)

I’ve never used Gitpod before so I can’t comment on the tool itself. Seems decent on first look.

General notes:

  • The only command needed is npm run serve
  • It does not detect the .nvmrc specifying the Node version it should use, would it be possible to integrate? Or can it detect an engines field in package.json?
  • «Wasting time on the setup», as it says in the OP and the Readme draft, is unnecessary hostile wording. I guess that this comes from you being a part of the Gitpod org and aligning with their mission :)

Out of curiosity: Is there a way to activate Prettier/code formatting on save? Just want to understand the capabilities of this tool a little better.

All in all, it can be a viable alternative to cloning locally. Especially as we currently don’t have a workflow to contribute definitions outside of a code editor.

@greatislander
Copy link
Contributor

Hi all, I don't have any objections to this and it does lower the barrier to entry. However, I think in terms of facilitating contributions from less technical contributors, the UI still feels very developer-oriented and so it might not have the desired impact.

@nisarhassan12
Copy link
Author

nisarhassan12 commented Mar 11, 2020

Thanks, @ovlb 🙂 .

The only command needed is npm run serve

The other command from the Gitpod setup is now removed.

It does not detect the .nvmrc specifying the Node version it should use, would it be possible to integrate? Or can it detect an engines field in package.json?

I'm working on this.

Out of curiosity: Is there a way to activate Prettier/code formatting on save? Just want to understand the capabilities of this tool a little better.

activated in e420645 by installing the Prettier VS Code Extension and adding a settings.json file.

Wasting time on the setup», as it says in the OP and the Readme draft, is unnecessary hostile wording. I guess that this comes from you being a part of the Gitpod org and aligning with their mission :)

removed in fafd7ed

@nisarhassan12
Copy link
Author

Hi all, I don't have any objections to this and it does lower the barrier to entry. However, I think in terms of facilitating contributions from less technical contributors, the UI still feels very developer-oriented and so it might not have the desired impact.

Thanks, @greatislander this Pr is about to simplify code contributions.

For authoring content Netlify Open Authoring is great and a lot easier.

@nisarhassan12
Copy link
Author

It does not detect the .nvmrc specifying the Node version it should use, would it be possible to integrate? Or can it detect an engines field in package.json?

@ovlb fixed in 40c9ed8

@tatianamac tatianamac added this to 🧰 Developer Experience (DX) in 📊 Self-Defined by Category May 14, 2020
@tatianamac
Copy link
Collaborator

@ovlb @greatislander Is there anything else we'd like to see here?

@ovlb
Copy link
Collaborator

ovlb commented May 23, 2020

@tatianamac I’ll have a final look tomorrow.

And, @nisarhassan12, sorry for the radio silence here.

@nisarhassan12
Copy link
Author

nisarhassan12 commented May 24, 2020

It does not detect the .nvmrc specifying the Node version it should use, would it be possible to integrate? Or can it detect an engines field in package.json?

@ovlb fixed in 40c9ed8

Sorry this is not fixed yet I initially thought it was but It turns out to be false.
The default Node version in Gitpod is 12.16.3 and the setup seems to be working fine.

I will try to figure out How to make it work. Thanks.

@tatianamac tatianamac closed this Jun 5, 2020
@nisarhassan12
Copy link
Author

@tatianamac Thanks! would you please tell why you closed this PR?

@tatianamac
Copy link
Collaborator

@nisarhassan12 Because I ported the repo over to a new org and renamed the main branch from master (which was problematic) to prod, I think you'll need to reopen it and make a PR to the new main branch (prod)

@nisarhassan12
Copy link
Author

Ok. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status · Hold Something blocks progress Type · DX Affects developer experience
Projects
📊 Self-Defined by Category
🧰 Developer Experience (DX)
Development

Successfully merging this pull request may close these issues.

None yet

4 participants