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.

Sign up for GitHub

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

Contributing code via pull requests #1804

Merged
merged 18 commits into from
Oct 6, 2021
Merged

Contributing code via pull requests #1804

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b35ac09
Fixed Spellings
roshnaeem Sep 17, 2021
3a9731a
Updated first half
roshnaeem Sep 20, 2021
691eafb
Updated second half
roshnaeem Sep 20, 2021
067b5af
Fixed a mistake
roshnaeem Sep 20, 2021
d584649
Added sync tabs
roshnaeem Sep 22, 2021
a8e9d04
Trying syntax
roshnaeem Sep 22, 2021
f17d17e
fixed syntax
roshnaeem Sep 22, 2021
5a6e541
fixed yntax
roshnaeem Sep 22, 2021
7c2c203
checking key syntax
roshnaeem Sep 23, 2021
b57e169
Fixed bullet points
roshnaeem Sep 23, 2021
37ed884
Checking syntax
roshnaeem Sep 23, 2021
17376e6
Sync tabs
roshnaeem Sep 23, 2021
3d267d3
Added sync tabs
roshnaeem Sep 23, 2021
8f431b3
Changed arviz api hyperlink
roshnaeem Sep 27, 2021
f7538db
fixed bullet points
roshnaeem Sep 28, 2021
c5604bc
Fixing the broken about us page
roshnaeem Sep 28, 2021
f5d8464
added admonition box
roshnaeem Oct 3, 2021
aebdfef
Trying other syntax for warning box
roshnaeem Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixed bullet points
  • Loading branch information
@roshnaeem
roshnaeem committed Oct 1, 2021
commit f7538db2eafeaf7e3ca30761ad9c0d9aa3743e82
74 changes: 37 additions & 37 deletions doc/source/contributing/contributing_prs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,63 +77,63 @@ Section in construction

# Steps

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

* Clone your fork of the ArviZ repo from your GitHub account to your local disk.
2. Clone your fork of the ArviZ repo from your GitHub account to your local disk.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


::::{tab-set}
::::{tab-set}

:::{tab-item} SSH
:sync: ssh
:::{tab-item} SSH
:sync: ssh

```
$ git clone git@github.com:<your GitHub handle>/arviz.git
```
:::
```
$ git clone git@github.com:<your GitHub handle>/arviz.git
```
:::

:::{tab-item} HTTPS
:sync: https
:::{tab-item} HTTPS
:sync: https

```
$ git clone https://github.com/<your GitHub handle>/arviz.git
```
:::
```
$ git clone https://github.com/<your GitHub handle>/arviz.git
```
:::

::::
::::

* Navigate to your arviz directory and add the base repository as a remote:
3. Navigate to your arviz directory and add the base repository as a remote:

::::{tab-set}
::::{tab-set}

:::{tab-item} SSH
:sync: ssh
:::{tab-item} SSH
:sync: ssh

```
$ cd arviz
$ git remote add upstream git@github.com:arviz-devs/arviz.git
```
:::
```
$ cd arviz
$ git remote add upstream git@github.com:arviz-devs/arviz.git
```
:::

:::{tab-item} HTTPS
:sync: https
:::{tab-item} HTTPS
:sync: https

```
$ cd arviz
$ git remote add upstream https://github.com/arviz-devs/arviz
```
:::
```
$ cd arviz
$ git remote add upstream https://github.com/arviz-devs/arviz
```
:::

::::
::::

* 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@roshnaeem roshnaeem Oct 2, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, on it


* Project requirements are in ``requirements.txt``, and libraries used for development are in ``requirements-dev.txt``. To set up a development environment, you may (probably in a [virtual environment](https://docs.python-guide.org/dev/virtualenvs/)) run:
5. Project requirements are in ``requirements.txt``, and libraries used for development are in ``requirements-dev.txt``. To set up a development environment, you may (probably in a [virtual environment](https://docs.python-guide.org/dev/virtualenvs/)) run:

```bash
$ pip install -r requirements.txt
Expand All @@ -143,7 +143,7 @@ $ git remote add upstream https://github.com/arviz-devs/arviz

Alternatively, for developing the project in [Docker](https://docs.docker.com/), there is a script to setup the Docker environment for development. See {ref}`developing_in_docker`.

* Develop the feature on your feature branch. Add your changes using git commands, ``git add`` and then ``git commit``, like:
6. Develop the feature on your feature branch. Add your changes using git commands, ``git add`` and then ``git commit``, like:

```bash
$ git add modified_files
Expand All @@ -163,7 +163,7 @@ $ git remote add upstream https://github.com/arviz-devs/arviz
$ git push -u origin my-feature
```

* Go to the GitHub web page of your fork of the ArviZ repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers.
7. Go to the GitHub web page of your fork of the ArviZ repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers.

(pr_checklist)=
# Pull request checklist
Expand Down