Plots2: Rename The Draft Method To Save_Draft For Clarity

Created on 28 Oct 2020  ยท  7Comments  ยท  Source: publiclab/plots2

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.

This issue was raised here based on the fact that the draft method also saves a node. Changing it from draft to save_draft makes it more clear.

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

๐Ÿ“‹ 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 $FILENAME in the $REPO 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:
Rename .draft method to save_draft on lines 1107 and 684 in the node.rb file
https://github.com/publiclab/plots2/blob/5ed9d5d8f9be585fcd6b853dd680a3437feef95e/app/models/node.rb#L1107

- def draft 
+def save_draft

https://github.com/publiclab/plots2/blob/5ed9d5d8f9be585fcd6b853dd680a3437feef95e/app/models/node.rb#L684

-node.draft if params[:draft] == "true"
+node.save_draft if params[:draft] == "true"

These changes should not break any tests, I have confirmed this.

  • [ ] ๐Ÿ’พ 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!

assigned first-timers-only

All 7 comments

Awesome! Thanks for opening this issue ๐ŸŽ‰

Hey! I'd like to take this for my first open source contribution if it's available!

Hi,
I would like to take this issue. I have not made any contribution on any open source project yet.

Hello, I will like to contribute to this project. Can I go ahead?

Hi, i have created my first pull request with this issue.

Hi @Guambo, and @melawlah you can reach out here or here to request for a first-timer issue.

Hi @saitgulmez thanks for creating the PR to fix it, please add a link of this issue in the PR you have created. @cesswairimu please assign this issue to @saitgulmez, he's already implemented it here

Thanks everyone

Was this page helpful?
0 / 5 - 0 ratings

Related issues

RuthNjeri picture RuthNjeri  ยท  3Comments

keshavsethi picture keshavsethi  ยท  3Comments

grvsachdeva picture grvsachdeva  ยท  3Comments

grvsachdeva picture grvsachdeva  ยท  3Comments

first-timers[bot] picture first-timers[bot]  ยท  3Comments