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

Jump to bottom

Update docs to reflect changes to testing, linting, and code contributions #28

Open
jsheunis opened this issue Apr 20, 2021 · 0 comments
Open

Update docs to reflect changes to testing, linting, and code contributions #28

jsheunis opened this issue Apr 20, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jsheunis
Copy link
Owner

Recent commits have added functionality for testing, automatic linting, and other ways to contribute to code. These need to be reflected in the fMRwhy documentation. Currently, basic descriptions and instructions are given in the README, which can be the starting point for updating the docs.

Also to be included:

  • developer setup (for docs, linting, testing, etc)
  • virtual environment management for Python

Consider shaving some content from the README accordingly.
@jsheunis jsheunis added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jsheunis