Contributing code via pull requests #1804
Conversation
roshnaeem
changed the title
| @@ -82,34 +80,47 @@ Section in construction | |||
|
|
|||
| 1. Fork the [project repository](https://github.com/arviz-devs/arviz/) by clicking on the 'Fork' button near the top right of the main repository page. This creates a copy of the code under your GitHub user account. | |||
|
|
|||
| 2. Clone your fork of the ArviZ repo from your GitHub account to your local disk, and add the base repository as a remote: | |||
| 2. Clone your fork of the ArviZ repo from your GitHub account to your local disk. | |||
There was a problem hiding this comment.
the double https/ssh double code alternatives look a bit bloated to me right now, can you try and see how they look with synced tabs from sphinx-design? ref #1751 (also double check that it doesn't break the about us page for example
|
|
||
| 3. Create a ``feature`` branch to hold your development changes: | ||
| 4. Create a ``feature`` branch to hold your development changes: | ||
|
|
||
| ```bash | ||
| $ git checkout -b my-feature | ||
| ``` | ||
|
|
||
| Always use a ``feature`` branch. It's good practice to never routinely work on the ``main`` branch of any repository. |
There was a problem hiding this comment.
Seeing how we often get PRs from main, maybe we could put this two sentences inside an important or warning admonitions so it pops up? Now that we have this here and not on github we can use all sphinx powered cool formatting
| > :warning: Always create a new ``feature`` branch before making any changes. Make your chnages | ||
| in the ``feature`` branch. It's good practice to never routinely work on the ``main`` branch of any repository. |
There was a problem hiding this comment.
this renders a bit strangely, it looks like a workaround to get admonitions in markdown. MyST supports them natively with the syntax shown in https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#directives-a-block-level-extension-point and https://jupyterbook.org/content/content-blocks.html#notes-warnings-and-other-admonitions.
Here is the list of all available admonitions for reference: https://sphinx-book-theme.readthedocs.io/en/latest/reference/kitchen-sink/paragraph-markup.html#admonitions
Description:
Updating the Contributing code via pull requests.