Skip to content

Commit

Permalink
update contrib & req docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Mar 6, 2025
1 parent ba9bee3 commit b6c7cb4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 26 deletions.
31 changes: 15 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ On this page, you can find information on:

## Reporting a Problem

To report an issue with the code, please submit it to our [issue tracker](https://github.com/fooof-tools/fooof/issues).
To report an issue with the code, please submit it to our
[issue tracker](https://github.com/fooof-tools/fooof/issues).

In doing so, please try to include the following:

Expand Down Expand Up @@ -49,30 +50,30 @@ If you have a new idea you would like to suggest or contribute, please do the fo
If you are interested in getting involved and helping with the project, a great place to start is to visit the
[issues](https://github.com/fooof-tools/fooof/issues) or
[development](https://github.com/fooof-tools/Development) page
and see if there is anything you would be interested in helping with. If so, join the conversation, and project developers can help get you started.
and see if there is anything you would be interested in helping with.
If so, join the conversation, and project developers can help get you started.

## Project Scope

All contributions must be within the scope of the module.

`specparam` is a module for parameterizing neural power spectra. This includes model fitting, management and analysis of resulting parameters, and utilities to visualize power spectra and model results. This module also includes functionality to simulate power spectra based on the model.
`specparam` is a module for parameterizing neural power spectra. This includes model fitting, management and analysis of resulting parameters, and utilities to visualize power spectra and model results. This module also includes functionality to simulate power spectra based on the model. Procedures and utilities that do not deal with operating upon power spectra or on model outputs will most likely be considered out of scope.

Procedures and utilities that do not deal with operating upon power spectra or on model outputs will most likely be considered out of scope. Notably, this model does not include doing spectral estimation or time-domain analysis. For approaches such as these, the [neurodsp](https://github.com/neurodsp-tools/neurodsp/) module may be a more appropriate target.
This module does not include doing spectral estimation or time-domain analysis. For approaches such as these, the [neurodsp](https://github.com/neurodsp-tools/neurodsp/) module may be a more appropriate target.

## Making a Contribution

If there is a feature you would like to add, or an issue you saw that you think you can help with, you are ready to make a submission to the project!
If there is a feature you would like to add, or an issue you saw that you think you can help with, you are ready to make a submission to the project! If you are working on a feature, please indicate so in the relevant issue, so that we can keep track of who is working on what.

If you are working on a feature, please indicate so in the relevant issue, so that we can keep track of who is working on what.
All contributions are managed through Github.
If you are ready to start working on a contribution, you should follow the Github
[guidelines for contributing to a project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project), which include forking the repository, making your suggested changes to the code, and then opening a pull request (PR) to suggest the code to the project.

Once you're ready to start working on your contribution, do the following:
Once you open a PR, developers will review the code. Please make sure to check and follow the
[project conventions](#project-conventions) so that all new or updated code follows the guidelines.

1. [Fork this repository](https://help.github.com/articles/fork-a-repo/), which makes your own version of this project you can edit
2. [Make your changes](https://guides.github.com/activities/forking/#making-changes), updating or adding code to add the desired functionality
3. [Check the project conventions](#project-conventions), and make sure all new or updated code follows the guidelines
4. [Submit a pull request](https://help.github.com/articles/proposing-changes-to-a-project-with-pull-requests/), to start the process of merging the new code to the main branch

If it's your first time contributing to open source software, check out this free resource on [how to contribute to an open-source project on GitHub](https://app.egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
If it's your first time contributing to open source software, check out this free resource on
[how to contribute to open-source projects on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).

## Project Conventions

Expand Down Expand Up @@ -119,9 +120,7 @@ All code contributed to the module should follow these conventions:
* Any new functionality should be added and described in the tutorials and/or examples
* If a new approach is added, a new tutorial or example may be appropriate
* To build and check the documentation locally:
* Install the requirements for the docsite (`pip install -r requirements-doc.txt`)
* Install the requirements for the docsite (`pip install -r requirements-docs.txt`)
* Move to the `specparam/doc` directory (`cd doc`)
* Run `make html` to create a local copy of the documentation website
* The documentation can then be opened in a web browser by opening the file `specparam/doc/_build/html/index.html`

For more guidelines on how to write well formated and organized code, check out the [Python API Checklist](http://python.apichecklist.com).
14 changes: 4 additions & 10 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
sphinx
sphinx-gallery
sphinx_bootstrap_theme
numpydoc
sphinx-copybutton
numpydoc

# Optional dependencies that are required for documentation
matplotlib
tqdm

# Requirements for running the examples
mne > 1.2

# Requirements for running the motivations
neurodsp >= 2.0.0
# Requirements for running the tutorials / examples / motivations
neurodsp >= 2.0.0
mne > 1.2

0 comments on commit b6c7cb4

Please sign in to comment.