Skip to content

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

Merged
merged 220 commits into from
Mar 30, 2022

Conversation

bishabosha
Copy link
Member

@bishabosha bishabosha commented Mar 21, 2022

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.

  • Add a single guide "Contributing to Scala"
  • Rename Scala 3's "Contribution Guide" to "Scala 3 Contributing Guide"

Steps taken to migrate contribute docs and preserve history:

  • Install git-filter-repo ( https://github.com/newren/git-filter-repo )
  • clone scala-lang to scratch dir
  • cd scratch/scala-lang - we are on branch main
  • git checkout -b src-main
  • remove remote: git remote rm origin
  • remove everything except the files of interest: git filter-repo --force --path _contribute_resources --path contribute
  • now record the hash of first commit on 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
  • record current head commit on pick-from-src-repo: 4a79b3f6233060eba7b151e596c3ec601bfcb1d4
  • play the commits of src-repo/src-main onto pick-from-src-repo: git filter-branch --parent-filter 'test $GIT_COMMIT = 6bea2efad6f3c3f41e43780dc937030f3515a323 && echo "-p 4a79b3f6233060eba7b151e596c3ec601bfcb1d4" || cat' HEAD
  • add back the files from 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
  • push to GitHub as move-contribute-from-scala-lang-precise-history

heathermiller and others added 30 commits May 3, 2012 14:30
and sketches for two pages:
 - bug reporting
 - documentation contributions
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.
@bishabosha bishabosha force-pushed the move-contribute-from-scala-lang-pr branch from d59d0eb to 573e494 Compare March 23, 2022 09:46
- also switch some code blocks to explicit html so that
  mdoc code blocks are not escaped.
@bishabosha
Copy link
Member Author

@julienrf I have addressed your comments from add-guides.md

@julienrf julienrf self-requested a review March 24, 2022 07:26
@SethTisue
Copy link
Member

@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.

@bishabosha
Copy link
Member Author

bishabosha commented Mar 30, 2022

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 /contribute/tools.html (should there be more tools listed?) and http://localhost:4000/contribute/partest-guide.html, are there links that should be updated for these tools? As for general modernising, I think that could be done in future PRs, except for a general comb over for inclusive language purposes.

Edit: overall though, as these links still go to live webpages, changing them can wait to further PRs

@bishabosha bishabosha force-pushed the move-contribute-from-scala-lang-pr branch from b150e45 to a220637 Compare March 30, 2022 14:36
@bishabosha
Copy link
Member Author

I've added my final changes to keep things up to date

@bishabosha bishabosha force-pushed the move-contribute-from-scala-lang-pr branch from a220637 to 3be3bec Compare March 30, 2022 14:47
@bishabosha bishabosha force-pushed the move-contribute-from-scala-lang-pr branch from 3be3bec to add60f3 Compare March 30, 2022 14:49
@bishabosha bishabosha merged commit 03460b3 into scala:main Mar 30, 2022
@bishabosha bishabosha deleted the move-contribute-from-scala-lang-pr branch March 30, 2022 14:55
@SethTisue
Copy link
Member

🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.