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 information about maintaining NiMARE to developer's guide #703

Merged
merged 3 commits into from Jun 15, 2022

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jun 11, 2022

Closes None, but is related to #701.

Changes proposed in this pull request:

  • Add section on project maintenance to developer's guide.

@tsalo tsalo added documentation Improving documentation for the project maintenance Issues/PRs related to maintenance/infrastructure. labels Jun 11, 2022
@codecov
Copy link

codecov bot commented Jun 11, 2022

Codecov Report

Merging #703 (f4a7412) into main (3d3d1ea) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #703      +/-   ##
==========================================
+ Coverage   85.31%   85.34%   +0.03%     
==========================================
  Files          41       41              
  Lines        4521     4539      +18     
==========================================
+ Hits         3857     3874      +17     
- Misses        664      665       +1     
Impacted Files Coverage Δ
nimare/workflows/macm.py 25.00% <0.00%> (-0.72%) ⬇️
nimare/meta/ibma.py 99.49% <0.00%> (+0.01%) ⬆️
nimare/workflows/ale.py 93.42% <0.00%> (+0.08%) ⬆️
nimare/dataset.py 89.96% <0.00%> (+0.23%) ⬆️
nimare/transforms.py 75.71% <0.00%> (+0.26%) ⬆️
nimare/workflows/conperm.py 90.00% <0.00%> (+0.34%) ⬆️
nimare/workflows/scale.py 81.08% <0.00%> (+0.52%) ⬆️

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 3d3d1ea...f4a7412. Read the comment docs.

@tsalo
Copy link
Member Author

tsalo commented Jun 13, 2022

@JulioAPeraza, I'd love to get your thoughts on this one. I want to expand the maintenance documentation, and you're the one who will use that documentation the most.

Copy link
Collaborator

@JulioAPeraza JulioAPeraza left a comment

Choose a reason for hiding this comment

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

Should we also add the guidelines for testing with local environments using pytest -v nimare and make html? The step will look like this:

conda create -p /path/to/nimare_env pip python=3.9
conda activate /path/to/nimare_env
pip install -e .[all]

@tsalo
Copy link
Member Author

tsalo commented Jun 14, 2022

Should we also add the guidelines for testing with local environments

I think that's a good idea. That's important for any devs, rather than just maintainers, so I'll add it to the overall development guide.

@tsalo
Copy link
Member Author

tsalo commented Jun 15, 2022

@JulioAPeraza is there anything else you'd like to see in this PR?

@JulioAPeraza
Copy link
Collaborator

No, I think this looks good.

@tsalo tsalo merged commit cb542af into neurostuff:main Jun 15, 2022
@tsalo tsalo deleted the maintainer-docs branch June 15, 2022 17:14
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 maintenance Issues/PRs related to maintenance/infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants