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

Delete Templating Methods from editor.js #9919

Closed
5 tasks
noi5e opened this issue Jul 19, 2021 · 2 comments · Fixed by #9923
Closed
5 tasks

Delete Templating Methods from editor.js #9919

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

Comments

@noi5e
Copy link
Contributor

noi5e commented Jul 19, 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.

There is some defunct code in the comment system's editor that's no longer used, that needs to be deleted! See #9069 for more context.

📋 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 app/assets/javascripts/editor.js 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:

editor.js: DELETE the following lines

Line 14:

-14 this.templates = { 'blog': "## The beginning\n\n## What we did\n\n## Why it matters\n\n## How can you help", 'default': "## What I want to do\n\n## My attempt and results\n\n## Questions and next steps\n\n## Why I'm interested", 'support': "## Details about the problem\n\n## A photo or screenshot of the setup", 'event': "## Event details\n\nWhen, where, what\n\n## Background\n\nWho, why", 'question': "## What I want to do or know\n\n## Background story" };

Lines 84-88:

-84 // these header formatting functions are not used anywhere, so commenting them out for now to pass codeclimate:
-85
-86 // h1() {
-87 //   this.wrap('#','')
-88 // }

Lines 92-107:

-92  // h3() {
-93  //   this.wrap('###','')
-94  // }
-95  // h4() {
-96  //   this.wrap('####','')
-97  // }
-98  // h5() {
-99  //   this.wrap('#####','')
-100  // }
-101  // h6() {
-102  //   this.wrap('######','')
-103  // }
-104  // h7() {
-105  //   this.wrap('#######','')
-106  // }
  • 💾 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 first-timers-only They need to be well-formatted using the First-timers_Issue_Template. JavaScript labels Jul 19, 2021
@jayeritz
Copy link
Contributor

Hi, I found this issue on ovio.org and would love to contribute! I'm Jamila and I have never contributed to your codebase before.

@jayeritz
Copy link
Contributor

Hi @noi5e. I created a pull request for this issue. Please let me know if you have any issues. Thank You!

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. JavaScript
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants