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

Refactoring coauthored notes query into a method in User.rb #1793

Closed
4 tasks
sagarpreet-chadha opened this issue Nov 21, 2017 · 4 comments
Closed
4 tasks

Refactoring coauthored notes query into a method in User.rb #1793

sagarpreet-chadha opened this issue Nov 21, 2017 · 4 comments
Labels
enhancement explains that the issue is to improve upon one of our existing features first-timers-only They need to be well-formatted using the First-timers_Issue_Template. help wanted requires help by anyone willing to contribute Ruby testing issues are usually for adding unit tests, integration tests or any other tests for a feature

Comments

@sagarpreet-chadha
Copy link
Contributor

sagarpreet-chadha commented Nov 21, 2017

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.

📋 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 https://github.com/publiclab/plots2/blob/master/app/views/dashboard/_node_meta.html.erb 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!
  • 💾 Commit your changes
  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

PROBLEM :

We need to Refactor the Coauthored notes query (soon to be used on profile pages like this to display posts an author has assisted with) into a method in the User.rb model (/app/models/user.rb) and to write a Unit test for it (in /test/unit/user_test.rb).

SOLUTION :

The query is given here :

@coauthored = Node.where(status: 1, type: "note")

The above query should be moved into the user.rb model as :

def coauthored_notes
    # the query goes here 
end

And the test for the above query goes here -- you can see other examples of tests in this file too:
test/unit/user_test.rb

Thank you!

Your help makes Public Lab better! We deeply appreciate your helping refine and improve this site.

To learn how to write really great issues, which increases the chances they'll be resolved, see:

https://publiclab.org/wiki/developers#Contributing+for+non-coders

@jywarren
Copy link
Member

Hi, awesome! I made some small tweaks to formatting and added some links directly to the code in places.

@jywarren jywarren added enhancement explains that the issue is to improve upon one of our existing features first-timers-only They need to be well-formatted using the First-timers_Issue_Template. help wanted requires help by anyone willing to contribute Ruby testing issues are usually for adding unit tests, integration tests or any other tests for a feature labels Nov 21, 2017
@zhirschtritt
Copy link
Contributor

I'd like to take this on!

@jywarren
Copy link
Member

jywarren commented Nov 21, 2017 via email

@zhirschtritt
Copy link
Contributor

This is he!

SrinandanPai pushed a commit to SrinandanPai/plots2 that referenced this issue May 5, 2019
…clab#1796)

* moves coauthored notes to user model

* adds coauthored_notes test in progress

* adds downcase for coathored_notes tagname

* refactor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement explains that the issue is to improve upon one of our existing features first-timers-only They need to be well-formatted using the First-timers_Issue_Template. help wanted requires help by anyone willing to contribute Ruby testing issues are usually for adding unit tests, integration tests or any other tests for a feature
Projects
None yet
Development

No branches or pull requests

3 participants