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

DOC, TODO: advanced dev docs #6266

Open
12 tasks
drammock opened this issue May 3, 2019 · 0 comments
Open
12 tasks

DOC, TODO: advanced dev docs #6266

drammock opened this issue May 3, 2019 · 0 comments

Comments

@drammock
Copy link
Member

drammock commented May 3, 2019

I'd been hoping we could avoid it and let the rest of the internet handle advanced git advice, but based on conversations in #6254, it seems like a troubleshooting / advanced git page might be wanted (at least by some)?

  • when, how, and why to rebase
  • tips like git push -u
  • git commit --amend and git push --force
  • git stash
  • git diff
  • discussion of git GUIs

Other advanced dev topics:

  • PR best practices (e.g., linking to changed doc pages on Circle after they render, when to add tests / changelog entries, etc)
  • overview of our CIs (memory limits, what gets tested where, etc)
  • figuring out why CircleCI / Azure / Travis errorred
  • reviewing PRs, making "suggestions", committing "suggestions" through the web UI...
  • profiling: link to sklearn profiling page
  • docstring formatting guidelines (e.g., where we deviate from the NumPyDoc style)

@jeythekey @massich @larsoner @mmagnuski

@drammock drammock changed the title DOC, TODO: advanced git page? DOC, TODO: advanced dev docs May 22, 2020
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

No branches or pull requests

1 participant