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

pull latest changes from dev #163

Merged
merged 6 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions doc/getting_started/how_to_contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to WhoBPyT Codebase
Authors: Andrew Clappison, Kevin Kadak, John Griffiths

The below instuctions outline how to properly adhere to version control for contributing to the WhoBPyT repo.

## Setting Up (Done Once):

- **Downloading your Fork**
- Must have already configured an authentication key and have forked the repository on github.com; ensure your fork is up-to-date with the whobpyt/dev branch from which your new branch will be created.
- Open terminal and go to the desired directory.
- `git clone [email protected]:<<your_github_account>>/whobpyt.git`

- **Adding Upstream**
- `cd whobpyt`
- `git remote add upstream https://github.com/GriffithsLab/whobpyt.git`
- `git fetch upstream`

## Coding Cycle (Done for each new feature or group of features):

- **Creating a New Branch**
- `git fetch upstream`
- `git checkout --track upstream/dev`
- `git push origin dev`
- `git checkout -b <<new_branch_name>>`

- **Editing Code**
- Add/Delete/Edit code

- **Testing (WhoBPyT Sphinx Examples should run successfully on Linux, but may fail to run on Windows)**
- Optionally: Rename sphinx examples ending in “r” to “x” if it is not relevant to the code changes done (for quicker debugging). Example: “eg001r...” to “eg001x...”.
- `cd doc`
- `make clean`
- `make html`
- Open and inspect in a web browser: whobpyt/doc/_build/html/html.txt
- Additional other testing may also be advised.

- **Committing Code**
- `git status`
- `git add <<edited_file_names>>`
- `git commit -m “<<commit_message>>”`

- **Pushing Code**
- `git push --set-upstream origin <<new_branch_name>>`

- **Creating a pull request**
- On github.com do a pull request from the new branch on your fork to the main repo’s dev branch. If there is a merging conflict, it will have to be addressed before proceeding.

15 changes: 7 additions & 8 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ mne


# Docs requirements
sphinx
#sphinx==3.1.1
sphinx-gallery==0.8.1
sphinx_rtd_theme==0.5.0
sphinx-tabs==1.3.0
sphinx-copybutton==0.3.1
sphinxcontrib-httpdomain==1.7.0
sphinx==5.0.0
sphinx-gallery==0.15.0
sphinx_rtd_theme==2.0.0
sphinx-tabs==3.4.4
sphinx-copybutton==0.5.2
sphinxcontrib-httpdomain==1.8.1
numpydoc==1.1.0
recommonmark==0.6.0
versioneer==0.19
Expand All @@ -28,7 +27,7 @@ nbsphinx
jupyter
ipykernel
jupyter-alabaster-theme
gdown
gdown==4.6
jinja2<3.1


Expand Down
Loading