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

I'd like to contribute #966

Closed
stokhos opened this issue Apr 3, 2021 · 3 comments
Closed

I'd like to contribute #966

stokhos opened this issue Apr 3, 2021 · 3 comments
Labels

Comments

@stokhos
Copy link
Contributor

stokhos commented Apr 3, 2021

Hi guys,
I'd like to contribute to ndarray, is there any issues that I can work on to help me get familiar with the internal codes?

best

@jturner314
Copy link
Member

jturner314 commented Apr 4, 2021

There are a few issues tagged with good first issue or help wanted. There's also a list of things in #597. I'd recommend asking before starting work on something, though, in case the relevant issue is out-of-date, and to discuss how to approach the implementation. As far as getting familiar with the internals of ndarray, it depends on what area you're interested in, since ndarray is a fairly large crate with a variety of functionality.

I mostly navigate the codebase with searching (ripgrep) and "go to definition", but these are a few pointers. The main type is ArrayBase, and the validity constraints for this type are described here. Most of the methods are implemented in src/impl_methods.rs. The various Data traits are in src/data_traits.rs. The Dimension trait is in src/dimension/dimension_trait.rs. Most of the slicing stuff is in src/slice.rs. Zip-related stuff is in src/zip/. The iterators are in src/iterators/.

Fwiw, I don't have much time myself to review PRs and suggest changes, so if the other maintainers are busy too, responses may be somewhat slow. Contributions are welcome, though.

@bluss
Copy link
Member

bluss commented Apr 4, 2021

I can explain that the src/impl_* convention is for all files that are part of impl ArrayBase. The many inherent methods of that type and its aliases are quite spread out, naturally.

@bluss bluss added the question label Apr 4, 2021
@stokhos
Copy link
Contributor Author

stokhos commented Apr 4, 2021

Got it. Big thanks guys! @bluss @jturner314

@stokhos stokhos closed this as completed Apr 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants