Skip to content

Commit fde254a

Browse files
DOC: Added CONTRIBUTING.rst (numpy#27469)
* 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]>
1 parent 4ea4268 commit fde254a

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.rst

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
===============================
2+
NumPy's Contributing guidelines
3+
===============================
4+
5+
Welcome to the NumPy community! We're excited to have you here.
6+
Whether you're new to open source or experienced, your contributions
7+
help us grow.
8+
9+
Pull requests (PRs) are always welcome, but making a PR is just the
10+
start. Please respond to comments and requests for changes to help
11+
move the process forward. Please follow our
12+
`Code of Conduct <https://numpy.org/code-of-conduct/>`__, which applies
13+
to all interactions, including issues and PRs.
14+
15+
For more, please read https://www.numpy.org/devdocs/dev/index.html
16+
17+
Thank you for contributing, and happy coding!

doc/source/dev/index.rst

+15
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,21 @@ we list them in alphabetical order):
1919
- Website design and development
2020
- Writing technical documentation
2121

22+
We understand that everyone has a different level of experience,
23+
also NumPy is a pretty well-established project, so it's hard to
24+
make assumptions about an ideal "first-time-contributor".
25+
So, that's why we don't mark issues with the "good-first-issue"
26+
label. Instead, you'll find `issues labeled "Sprintable" <https://github.com/numpy/numpy/labels/sprintable>`__.
27+
These issues can either be:
28+
29+
- **Easily fixed** when you have guidance from an experienced
30+
contributor (perfect for working in a sprint).
31+
- **A learning opportunity** for those ready to dive deeper,
32+
even if you're not in a sprint.
33+
34+
Additionally, depending on your prior experience, some "Sprintable"
35+
issues might be easy, while others could be more challenging for you.
36+
2237
The rest of this document discusses working on the NumPy code base and documentation.
2338
We're in the process of updating our descriptions of other activities and roles.
2439
If you are interested in these other activities, please contact us!

0 commit comments

Comments
 (0)