Skip to content

Commit

Permalink
updating issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
getify committed Aug 28, 2019
1 parent 8283dab commit 29390bc
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 14 deletions.
16 changes: 15 additions & 1 deletion .github/ISSUE_TEMPLATE/content-question.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
---
name: Content Question
about: Ask a question about something you read in the books?
labels:
labels:

---

**Yes, I promise I've read the [Contributions Guidelines](https://github.com/getify/You-Dont-Know-JS/blob/master/CONTRIBUTING.md)** (please feel free to remove this line).

----

**Please type "I already searched for this issue":**

**Edition:** (1st or 2nd)

**Book Title:**

**Chapter:**

**Section Title:**

**Question:**
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/foreign-translation-request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
name: Foreign Translation Request
about: Want to request a translation into a foreign language?
labels:
labels:

---

Foreign translations are appreciated. However, any such requests should wait until the 2nd edition is complete.

**I will not be accepting any new foreign translations for previous editions.**

----

Please check these issues first:

* https://github.com/getify/You-Dont-Know-JS/issues?utf8=%E2%9C%93&q=label%3A%22foreign+language+translations%22+
Expand Down
16 changes: 15 additions & 1 deletion .github/ISSUE_TEMPLATE/report-technical-mistake.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
---
name: Report Technical Mistake
about: Help us fix a mistake in the code.
labels:
labels:

---

**Yes, I promise I've read the [Contributions Guidelines](https://github.com/getify/You-Dont-Know-JS/blob/master/CONTRIBUTING.md)** (please feel free to remove this line).

----

**Please type "I already searched for this issue":**

**Edition:** (1st or 2nd)

**Book Title:**

**Chapter:**

**Section Title:**

**Problem:**
16 changes: 15 additions & 1 deletion .github/ISSUE_TEMPLATE/textual-grammar-typo.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
---
name: Textual/Grammar Typo
about: Help us correct a spelling or grammar error in the text.
labels:
labels:

---

**Yes, I promise I've read the [Contributions Guidelines](https://github.com/getify/You-Dont-Know-JS/blob/master/CONTRIBUTING.md)** (please feel free to remove this line).

----

**Please type "I already searched for this issue":**

**Edition:** (1st or 2nd)

**Book Title:**

**Chapter:**

**Section Title:**

**Problem:**
14 changes: 5 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please feel free to contribute to the quality of this content by submitting PR's for improvements to code snippets, explanations, etc. If there's any doubt or if you think that a word/phrase is used confusingly, **before submitting a PR, open an issue to ask about it.**

However, if you choose to contribute content (not just typo corrections) to this repo, you agree that you're giving me a non-exclusive license to use that content for the book, as I (and my publisher) deem appropriate. You probably guessed that already, but I just have to make sure the lawyers are happy by explicitly stating it.
However, if you choose to contribute content (not just typo corrections) to this repo, you agree that you're giving me a non-exclusive license to use that content for the book, as I (and my publisher) deem appropriate. You probably guessed that already, but I just wanted to be extra clear on that.

## Reading Experience (Chapter/Section links, etc)

Expand All @@ -14,21 +14,17 @@ The main purpose of my book repos is to track and manage the content for the pur

As such, this repo **is not optimized for your reading experience.**

The primary reading experience, likely the most pleasant one for many of you, is the ebooks or print books, which [are available for sale](http://ssearch.oreilly.com/?q=%22you+don%27t+know+js%22&x=0&y=0). The balance I'm striking here is releasing the content for free, but selling the reading experience. Other authors make different decisions on that balance, but that's what I've come to for now.

I hope you continue to enjoy and benefit from the content, and I also hope you value it enough to [purchase the best reading experience](http://ssearch.oreilly.com/?q=%22you+don%27t+know+js%22&x=0&y=0) in the ebook/print form.
The intended **best reading experience** are the published books (either ebook or print), so I encourage you to purchase them for that purpose.

## Editions

The current state of this repo is the 1st Edition of the published form of these books. That means that you should have almost exactly the same content here as in the ebooks or printed books, with only minor variances in typos, formatting, etc.

I generally am not accepting any changes to the current repo, as I do not want this content to diverge from what's in the published books. There are over a hundred filed issues/PRs for changes that are being collected for the 2nd Edition, but work has not yet begun on that.
The current edition (*work in progress*) of the books is the 2nd edition. While these 2nd edition books are in progress, feel free to provide any contributions.

So, if you find something that should be fixed, just know that it will likely sit for awhile in that batch until it's time to make the 2nd Edition updates. At that time, my plan is to make separate branches to track the editions.
I **am not accepting any contributions** for previous edition books.

## Typos?

These books go through official editing with the publisher, and typos are likely all caught at that stage. As such, **typos are not a big concern for this repo**.
Please don't worry about minor text typos. These will almost certainly be caught during the editing process.

If you're going to submit a PR for typo fixes, please be measured in doing so by collecting several small changes into a single PR (in separate commits). Or, **just don't even worry about them for now,** because we'll get to them later. I promise.

Expand Down
14 changes: 14 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
**Yes, I promise I've read the [Contributions Guidelines](https://github.com/getify/You-Dont-Know-JS/blob/master/CONTRIBUTING.md)** (please feel free to remove this line).

----

**Please type "I already searched for this issue":**

**Edition:** (1st or 2nd)

**Book Title:**

**Chapter:**

**Section Title:**

**Topic:**
14 changes: 14 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
**Yes, I promise I've read the [Contributions Guidelines](https://github.com/getify/You-Dont-Know-JS/blob/master/CONTRIBUTING.md)** (please feel free to remove this line).

----

**Please type "I already searched for this issue":**

**Edition:** (1st or 2nd)

**Book Title:**

**Chapter:**

**Section Title:**

**Topic:**
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is a series of books diving deep into the core mechanisms of the JavaScript

## Premier Sponsor

This edition of the **YDKJS** book series is exclusively sponsored by [Frontend Masters](https://frontendmasters.com).
This edition of the **YDKJS(Y)** book series is exclusively sponsored by [Frontend Masters](https://frontendmasters.com).

Frontend Masters is the gold standard for top-of-the-line expert training material in frontend-oriented software development. With over 150 courses on all things frontend, this should be your first and only stop for quality video training on HTML, CSS, JS, and related technologies.

Expand Down

0 comments on commit 29390bc

Please sign in to comment.