Add CONTRIBUTING.md - #484
Merged
Merged
Conversation
Guidance so far has been one line in the README: "Contributions are welcome! Feel free to reach out or submit a pull request." That is welcoming, and it leaves both sides without a shared reference. Substantial contributions have arrived fully implemented, which puts a maintainer in the position of either accepting something outside the package's purpose or declining work that is already finished -- a decision that would have been much cheaper for everyone before it was written. Scope, stated so that a decline can point at a rule rather than a judgement. The line is drawn around what an indicator IS, not around whether the underlying statistic is novel: variance, autocorrelation, entropy and DFA are all general statistics, and they belong here because the package computes them over a rolling window as resilience indicators. What does not belong is statistical machinery that is not itself an indicator. Issue first for anything larger than a bug fix, with a stated timescale and a fallback. An unbounded "open an issue and wait" fails invisibly: there is no abandoned pull request to notice, just an issue nobody followed up. So the section says a reply can take a couple of weeks, and says what to do if it does not come. Shape, with helpers.dfa + TimeSeries.compute_dfa + tests/test_dfa.py named as the pattern to copy, since describing an architecture is less use than pointing at an example of it. Older methods in core.py that compute inline are noted as staying that way, rather than described as if they already followed the rule or promised for an unscheduled migration. A setup section, because the checklist below it was unreachable without one. The commands are the ones a fresh clone actually needs, and the TensorFlow skip is called out so it does not read as a failure. The pre-PR checklist says what is genuinely verified and what is not. The docs build treats warnings as errors, so a malformed docstring fails the PR -- but nothing notices a module missing from docs/source/ewstools.rst, and a new function in an existing module needs no docs edit at all, because automodule already picks it up. The CHANGELOG instruction says to create the Unreleased heading, which has never existed in this repository. Small fixes are exempted in the second paragraph, so none of the above stands between someone and a typo correction. The README line now points here.
energyscholar
force-pushed
the
docs/contributing
branch
from
September 18, 2026 03:02
d918e31 to
4a20620
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As discussed by email — a short contribution guide, so the package has a stated scope to point at.
Three rules:
core.pypredate this and the file says so, rather than describing an architecture that isn't there yet.Plus the pre-PR checklist that has been informal until now — a test with a known answer, a docstring citing the method, the
__init__export and thedocs/source/ewstools.rstentry, and a CHANGELOG line.Docs only; no code touched. The README's one-line invitation now points here.
Happy to reword any of it — it's your package's policy, I've just written it down.