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

Add instructions to download from GitHub and how to make a contribution #720

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add instructions to download from GitHub and how to make a contribution #720

wants to merge 2 commits into from

Conversation

riccardoleone1991
Copy link

@riccardoleone1991 riccardoleone1991 commented Jun 16, 2022

Closes #718 .

Changes proposed in this pull request:

  • Added helpful notes in dev_guide.rst

@welcome
Copy link

welcome bot commented Jun 16, 2022

Thanks for opening this pull request! We have detected this is the first time you have contributed to NiMARE. Please check out our contributing guidelines.
We invite you to list yourself as a NiMARE contributor, so if your name is not already mentioned, please modify the .zenodo.json file with your data right above Angie's entry. Example:

{
  "name": "Contributor, New",
  "affiliation": "Department of Psychology, Some University",
  "orcid": "<your id>"
},
{
  "name": "Laird, Angela R.",
  "affiliation": "Florida International University",
  "orcid": "0000-0003-3379-8744"
},

Of course, if you want to opt out this time there is no problem at all with adding your name later. You will be always welcome to add it in the future whenever you feel it should be listed.

@codecov
Copy link

codecov bot commented Jun 16, 2022

Codecov Report

Merging #720 (25dd735) into main (cb542af) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #720   +/-   ##
=======================================
  Coverage   85.34%   85.34%           
=======================================
  Files          41       41           
  Lines        4539     4539           
=======================================
  Hits         3874     3874           
  Misses        665      665           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cb542af...25dd735. Read the comment docs.

Copy link
Member

@jdkent jdkent left a comment

Choose a reason for hiding this comment

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

need to change hyperlink, otherwise LGTM

docs/dev_guide.rst Outdated Show resolved Hide resolved
@tsalo tsalo added the documentation Improving documentation for the project label Jun 17, 2022
Comment on lines +26 to +30
First, you need to clone the NiMARE repository on github.

.. code-block:: bash

git clone https://github.com/neurostuff/NiMARE.git
Copy link
Member

Choose a reason for hiding this comment

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

I think creating a fork and cloning that is a necessary step for folks who want to install NiMARE for development.

@jdkent jdkent reopened this Jun 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improving documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

improve existing developer guide
3 participants