-
Notifications
You must be signed in to change notification settings - Fork 1k
Migrate contribute section from scala-lang to a guide #2350
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
Migrate contribute section from scala-lang to a guide #2350
Conversation
and sketches for two pages: - bug reporting - documentation contributions
… into an include for future reuse
Just trying to clean up and fill in holes in the hacker guide. Review @xeno_by
Maruku did not like that big HTML comment, for some reason.
d59d0eb
to
573e494
Compare
- also switch some code blocks to explicit html so that mdoc code blocks are not escaped.
@julienrf I have addressed your comments from |
@bishabosha what kind of review would you like from me here? I'm definitely strongly in favor of the change overall. And I appreciate the extra effort you took to preserve the version control history. It would be time-consuming for me to go over the whole thing with a fine-tooth comb, so I'm inclined to just say "LGTM!", but if there are particular aspects of this you'd like feedback on, let me know. |
@SethTisue Thank you for offering! I think it could be useful to update references to tools I do not understand, such as DBuild and Partest, which are linked from Edit: overall though, as these links still go to live webpages, changing them can wait to further PRs |
b150e45
to
a220637
Compare
I've added my final changes to keep things up to date |
a220637
to
3be3bec
Compare
3be3bec
to
add60f3
Compare
🎉 |
Add a new guide based from https://scala-lang.org/contribute - I have copied the files over including their history, before performing updates on top.
Steps taken to migrate contribute docs and preserve history:
scala-lang
toscratch
dircd scratch/scala-lang
- we are on branchmain
git checkout -b src-main
git remote rm origin
git filter-repo --force --path _contribute_resources --path contribute
src-main
:6bea2efad6f3c3f41e43780dc937030f3515a323
cd docs.scala-lang
git add remote src-repo ../scratch/scala-lang
git fetch src-repo
git checkout -b pick-from-src-repo
pick-from-src-repo
:4a79b3f6233060eba7b151e596c3ec601bfcb1d4
src-repo/src-main
ontopick-from-src-repo
:git filter-branch --parent-filter 'test $GIT_COMMIT = 6bea2efad6f3c3f41e43780dc937030f3515a323 && echo "-p 4a79b3f6233060eba7b151e596c3ec601bfcb1d4" || cat' HEAD
docs.scala-lang
:git filter-branch --index-filter 'git reset 4a79b3f6233060eba7b151e596c3ec601bfcb1d4 -- .bundle .github .gitignore CODE_OF_CONDUCT.md Dockerfile Gemfile Gemfile.lock README.md _ba _books _cheatsheets _config.yml _data _de _es _fr _getting-started _glossary _includes _it _ja _ko _layouts _overviews _pl _plugins _pt-br _ru _sass _scala3-reference _sips _style _th _tour _zh-cn _zh-tw api books.md conduct.html contribute.md docker-compose.yml guides.md index.md learn.md news online-courses.md reference.md resources scala3 scripts tutorials.md' -f -- 4a79b3f6233060eba7b151e596c3ec601bfcb1d4..HEAD