Link to new contributing documentation #578
Conversation
petertseng
force-pushed
the
contributing-guide
branch
from
7ec17c1 to
6c64703
Compare
|
Excuse me for pushing onto this branch, it's because I merged the #577 first and now Branch protection "Require branches to be up to date before merging" requires a rebase on master (or a merge commit on this branch which I would then squash). #445 (comment) indicates that you could possibly disable that. I guess our desired settings would be: But it's not urgent since in the case of many PRs I just octomerge. It can be checked that I changed nothing about the commit except to rebase it on master. $ diff -u <(git diff -u 7ec17c1~ 7ec17c1) <(git diff -u 6c64703~ 6c64703)
--- /proc/self/fd/11 2017-07-16 07:41:47.391717114 +0000
+++ /proc/self/fd/12 2017-07-16 07:41:47.395050420 +0000
@@ -1,5 +1,5 @@
diff --git a/README.md b/README.md
-index 5e1b949..da2f53c 100644
+index ea42568..ab76a35 100644
--- a/README.md
+++ b/README.md
@@ -54,11 +54,11 @@ Of course you can also add a totally new exercise, but it might be a good idea t |
README.md
Outdated
| @@ -54,11 +54,11 @@ Of course you can also add a totally new exercise, but it might be a good idea t | |||
|
|
|||
| #### Updating an exercise test suite | |||
| Updating a test suite of an existing exercise is special because it usually affects all languages. | |||
| You can refer to the [documentation on updating a test suite](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#updating-an-exercise-test-suite). | |||
| You can refer to the [documentation on updating a test suite](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md#updating-an-exercise-test-suite). | |||
There was a problem hiding this comment.
this anchor doesn't exist in this file. Any other file it should be instead?
There was a problem hiding this comment.
Yes, this would be the link: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/test-suites.md I'll change it.
There was a problem hiding this comment.
I am also considering https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md#changing-exercise-test-suites . Let me read the two and think about it.
There was a problem hiding this comment.
I would suggest that https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md#changing-exercise-test-suites is a closer analogue to the previous link. It is possible that we could use both links though?
There was a problem hiding this comment.
Yeah, their intentions are different. The anatomy one is a high-level overview of the tests, and the contributing link is more action-oriented.
README.md
Outdated
| Note that the whole test suite must run with the sample solution within a couple of seconds. | ||
|
|
||
| ### Repository structure and conventions | ||
| The [track anatomy documentation](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#track-anatomy) is a general description of all the files and directories that are not explicitly described below. | ||
| The [track anatomy documentation](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md#track-anatomy) is a general description of all the files and directories that are not explicitly described below. |
There was a problem hiding this comment.
Same, anchor is not in the file. Any other file it can be?
There was a problem hiding this comment.
Let's use https://github.com/exercism/docs/blob/master/language-tracks/README.md
I'll update this now.
kytrinyx
force-pushed
the
contributing-guide
branch
from
6c64703 to
c54faf2
Compare
|
There's a "rebase and merge" option. If you use "update branch" first, then "rebase and merge", the merge commit should go away. I think. Maybe. |
We moved the contributing documentation out of the problem specifications repository.
kytrinyx
force-pushed
the
contributing-guide
branch
from
c54faf2 to
0e6317d
Compare
|
With rebase and merge it seemed as if I had to use the web UI to see what PR the commit came from, whereas with squash and merge it went in the commit message, so I preferred the latter. Only applicable if it is OK to have just one commit in the end result, of course. If more than one commit is needed, it had to be rebase and merge. |
|
OK, so something like that, then? |
|
I like it. |
We moved the contributing documentation out of the problem specifications repository.