Skip to content

Commit

Permalink
DOC: Added CONTRIBUTING.rst (numpy#27469)
Browse files Browse the repository at this point in the history
* added CONTRIBUTING.rst

* split

* updated - addressing charris's comment

* indentation

Co-authored-by: Xiao Yuan <[email protected]>

* [skip actions][skip azp][skip cirrus]

---------

Co-authored-by: Xiao Yuan <[email protected]>
  • Loading branch information
Schefflera-Arboricola and yuanx749 authored Oct 14, 2024
1 parent 4ea4268 commit fde254a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
===============================
NumPy's Contributing guidelines
===============================

Welcome to the NumPy community! We're excited to have you here.
Whether you're new to open source or experienced, your contributions
help us grow.

Pull requests (PRs) are always welcome, but making a PR is just the
start. Please respond to comments and requests for changes to help
move the process forward. Please follow our
`Code of Conduct <https://numpy.org/code-of-conduct/>`__, which applies
to all interactions, including issues and PRs.

For more, please read https://www.numpy.org/devdocs/dev/index.html

Thank you for contributing, and happy coding!
15 changes: 15 additions & 0 deletions doc/source/dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ we list them in alphabetical order):
- Website design and development
- Writing technical documentation

We understand that everyone has a different level of experience,
also NumPy is a pretty well-established project, so it's hard to
make assumptions about an ideal "first-time-contributor".
So, that's why we don't mark issues with the "good-first-issue"
label. Instead, you'll find `issues labeled "Sprintable" <https://github.com/numpy/numpy/labels/sprintable>`__.
These issues can either be:

- **Easily fixed** when you have guidance from an experienced
contributor (perfect for working in a sprint).
- **A learning opportunity** for those ready to dive deeper,
even if you're not in a sprint.

Additionally, depending on your prior experience, some "Sprintable"
issues might be easy, while others could be more challenging for you.

The rest of this document discusses working on the NumPy code base and documentation.
We're in the process of updating our descriptions of other activities and roles.
If you are interested in these other activities, please contact us!
Expand Down

0 comments on commit fde254a

Please sign in to comment.