Repository navigation
docs: clarify differential methods and contribution forms #60
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
Merged
JoshuaJewell
merged 3 commits into
JoshuaJewell:main
from
hyperpolymath:repair/documentation
Oct 17, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
9fc2f71
docs: explain differential methods and streamline contribution forms
hyperpolymath ea974a2
docs: clarify that workspace does not apply sample read bounds
hyperpolymath f841caa
docs: clarify study-scoped differential options and fix contribution …
hyperpolymath File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| name: Bug report | ||
| description: Something in MetaManifold does not work as documented. | ||
| labels: [bug] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Search the existing issues first. Raise issues about a fork's own code on that fork. | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps or command | ||
| description: The command you ran, or the steps in the web interface, so that someone else can repeat them. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What you expected | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: actual | ||
| attributes: | ||
| label: What happened | ||
| description: Include the error message, the server log lines, or a screenshot. | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: julia | ||
| attributes: | ||
| label: Julia version | ||
| placeholder: output of `julia --version` | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: r | ||
| attributes: | ||
| label: R version | ||
| description: Only if the problem touches the R runtime; leave empty if you do not know it. | ||
| placeholder: output of `R --version | head -1` | ||
| - type: input | ||
| id: browser | ||
| attributes: | ||
| label: Browser and version | ||
| description: Only for problems in the web interface; leave empty for command-line reports. | ||
| - type: input | ||
| id: commit | ||
| attributes: | ||
| label: MetaManifold commit | ||
| placeholder: output of `git rev-parse --short HEAD` | ||
| - type: textarea | ||
| id: config | ||
| attributes: | ||
| label: Relevant configuration | ||
| description: The keys from `pipeline.yml` or the run's `run_config.yml` that bear on the problem. | ||
| render: yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| name: Feature request | ||
| description: Suggest a new feature or a change to an existing one. | ||
| labels: [enhancement] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Search the existing issues first. To change an architectural decision, describe the change | ||
| here before writing any code. The settled decisions in CONTRIBUTING.md can be discussed in an | ||
| issue, but a pull request does not reopen them. | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem | ||
| description: What you are trying to do, and what stops you now. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposed change | ||
| description: What MetaManifold should do instead. For a statistical method, name the method and a reference for it. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| - type: dropdown | ||
| id: area | ||
| attributes: | ||
| label: Area | ||
| options: | ||
| - Pipeline stages | ||
| - Analysis and statistics | ||
| - Web interface | ||
| - Configuration | ||
| - Installation and toolchain | ||
| - Other | ||
| validations: | ||
| required: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Change and reason | ||
|
|
||
| <!-- One logical change. Link relevant issues without claiming to close unrelated work. --> | ||
|
|
||
| ## Validation | ||
|
|
||
| <!-- Exact commands, results, and Julia/R/bun versions actually tested. | ||
| State explicitly what was not run. --> | ||
|
|
||
| ## Scope | ||
|
|
||
| <!-- What related work is left out? Explain any necessary lockfile change. --> | ||
|
|
||
| ## Contribution checks | ||
|
|
||
| - [ ] I followed [CONTRIBUTING.md](https://github.com/JoshuaJewell/MetaManifold-WebUI/blob/main/CONTRIBUTING.md). | ||
| - [ ] This branch starts at current upstream main and contains no merges from fork main. | ||
| - [ ] CI has run and passes. | ||
| - [ ] Existing licensing, citation and acknowledgement text is unchanged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.