-
Notifications
You must be signed in to change notification settings - Fork 262
docs: add CONTRIBUTING.md #407
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
Open
ANANYA542
wants to merge
6
commits into
mllam:main
Choose a base branch
from
ANANYA542:docs/contributing-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
fae2119
Add contributing guide for new developers
ANANYA542 fbd5998
updated- contribution.md
ANANYA542 f4f8295
docs: rewrite CONTRIBUTING.md β concise, no duplication with README/Pβ¦
cecbf9f
Updates slack link
7662dfa
Merge branch 'main' into docs/contributing-guide
sadamov c3161ba
Merge branch 'main' into docs/contributing-guide
sadamov 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,59 @@ | ||
| # Contributing to Neural-LAM | ||
|
|
||
| Thank you for your interest in contributing to Neural-LAM! | ||
| We welcome bug reports, bug fixes, documentation improvements, and new features. | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. **Open or find an issue.** Before writing code, open a | ||
| [GitHub issue](https://github.com/mllam/neural-lam/issues) describing what | ||
| you plan to do. If an issue already exists, comment so others know you are | ||
| working on it. | ||
|
|
||
| 2. **Read the existing discussion.** Review the full issue thread and any | ||
| linked PRs β someone may have already proposed a solution or identified a | ||
| blocker. | ||
|
|
||
| 3. **Set up your environment.** Fork the repo via the GitHub UI, then follow | ||
| the [Installing Neural-LAM section of the README](README.md#installing-neural-lam) | ||
| using the `--group dev` flag. Then activate the hooks: | ||
|
|
||
| ```bash | ||
| pre-commit install | ||
| ``` | ||
|
|
||
| ## Code standards | ||
|
|
||
| Code quality is enforced automatically by | ||
| [pre-commit hooks](.pre-commit-config.yaml) (Black, isort, Flake8, mypy, | ||
| Codespell and others). In addition: | ||
|
|
||
| - Add **NumPy-style docstrings** and **type annotations** to every public | ||
| function and class. | ||
| - Keep new code consistent with the patterns already in the codebase. | ||
|
|
||
| ## Before you push | ||
|
|
||
| Run **both** checks locally β they are the same ones CI will run: | ||
|
|
||
| ```bash | ||
| pre-commit run --all-files | ||
| pytest -vv -s --doctest-modules | ||
| ``` | ||
|
|
||
| > **Note:** The first test run downloads ~50 MB of example data via | ||
| > [pooch](https://www.fatiando.org/pooch/). | ||
|
|
||
| ## Pull requests | ||
|
|
||
| 1. Push your branch and open a PR against `main`. | ||
| 2. Fill in the | ||
| [pull request template](.github/pull_request_template.md) β it contains the | ||
| full checklists for authors, reviewers, and assignees, including the | ||
| CHANGELOG entry format. | ||
| 3. A maintainer will review your PR. Small, focused PRs are reviewed faster. | ||
|
|
||
| ## Getting help | ||
|
|
||
| - Join the [mllam Slack workspace]( https://join.slack.com/t/ml-lam/shared_invite/zt-3jyw20n4g-ESRxMPPSijiZ2ZA6Nh8XhA) | ||
| - [Open a GitHub issue](https://github.com/mllam/neural-lam/issues) | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace with short URL that is stable:
[mllam Slack workspace](kutt.to/mllam)