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

Update README.md to Include Setup for React & webpacker #9392

Closed
5 tasks
noi5e opened this issue Mar 30, 2021 · 2 comments · Fixed by #9408
Closed
5 tasks

Update README.md to Include Setup for React & webpacker #9392

noi5e opened this issue Mar 30, 2021 · 2 comments · Fixed by #9408
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.

Comments

@noi5e
Copy link
Contributor

noi5e commented Mar 30, 2021

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

❓ Why Are We Doing This?

With react-rails & webpacker installed in #9175/#9176, there's an extra step required when doing setup for our app.

Particularly, new contributors need to run rails setup commands, which are described in the react-rails documentation.

Note that this issue is distinct from #9382, which is about builds failing in the stable deployment.

📋 Step by Step

  • 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

  • 📝 Update the file README.md in the plots2 repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

File to Change: README.md

+114 10. Setup React & webpacker by running `rails webpacker:install && rails webpacker:install:react && rails generate react:install`
  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • 🏁 Done Ask in comments for a review :)

Please keep us updated

💬⏰ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below!

@noi5e noi5e added the first-timers-only They need to be well-formatted using the First-timers_Issue_Template. label Mar 30, 2021
@kulsoomzahra
Copy link
Contributor

Hey! Can i work on this issue?

@kulsoomzahra
Copy link
Contributor

#9408
Please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants