Skip to content

Commit 053b499

Browse files
committed
Add contributing guidelines
1 parent f82963d commit 053b499

File tree

1 file changed

+123
-0
lines changed

1 file changed

+123
-0
lines changed

docs/dev_contribute.rst

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
Contributing Guidelines
2+
=======================
3+
4+
First off, thank you for considering contributing to JupyterLab-URDF 🥳. It's
5+
people like you that make JupyterLab-URDF such a great tool.
6+
7+
Following these guidelines helps to communicate that you respect the time of the
8+
developers managing and developing this open source project. In return, they
9+
should reciprocate that respect in addressing your issue, assessing changes, and
10+
helping you finalize your pull requests.
11+
12+
JupyterLab-URDF is an open source project and we love to receive contributions
13+
from our community — you! There are many ways to contribute. For example, you
14+
could
15+
16+
* write a new tutorial or a blog post
17+
* improve the documentation or the existing examples
18+
* submit bug reports or feature requests
19+
* write code to incorporate into JupyterLab-URDF itself
20+
21+
Ground Rules
22+
------------
23+
24+
We welcome all kinds of contribution and value them highly. We pledge to treat
25+
everyone's contribution fairly and with respect, and we are here to bring
26+
awesome pull requests over the finish line.
27+
28+
Please note that we adhere to the `Python Community Code of Conduct
29+
<https://www.python.org/psf/conduct/>`_ and by contributing to this project
30+
you also agree to follow the same guidelines.
31+
32+
Your First Contribution
33+
-----------------------
34+
35+
Working on your first Pull Request? Here are some resources to help you get started:
36+
37+
* `First Timers Only <https://www.firsttimersonly.com/>`_
38+
* `Make a Pull Request <https://makeapullrequest.com/>`_
39+
* `How to Contribute to an Open Source Project on GitHub <https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github>`_
40+
41+
At this point, you're ready to make your changes! Feel free to ask for help;
42+
everyone is a beginner at first 😸.
43+
44+
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
45+
has changed and that you need to update your branch so that it's easier to
46+
merge.
47+
48+
Getting Started
49+
---------------
50+
51+
#. Create your own fork of the repository.
52+
#. Do the changes in your fork.
53+
#. If your changes only involve spelling or grammar fixes, move to step 6.
54+
#. Test your changes in a clean environment and update installation instructions and dependencies as needed.
55+
#. When adding new features, make sure to update the documentation and provide an example.
56+
#. If you are happy with your changes, create a pull request.
57+
58+
How to Report a Bug
59+
-------------------
60+
61+
**Security**
62+
63+
If you find a security vulnerability, do NOT open an issue. Email
64+
`isabel.paredes@quantstack.net <mailto:isabel.paredes@quantstack.net>`_ instead.
65+
In order to determine whether you are dealing with a security issue, ask
66+
yourself these two questions:
67+
68+
* Can I access something that's not mine, or something I shouldn't have access to?
69+
* Can I disable something for other people?
70+
71+
If the answer to either of those two questions is *YES*, then you're probably
72+
dealing with a security issue. Note that even if you answer *NO* to both
73+
questions, you may still be dealing with a security issue, so if you're unsure,
74+
just email us.
75+
76+
**Other bugs**
77+
78+
When filing an issue, make sure to answer these five questions:
79+
80+
#. What version of ``jupyterlab-urdf`` are you using?
81+
#. What operating system and processor architecture are you using?
82+
#. What did you do?
83+
#. What did you expect to see?
84+
#. What did you see instead?
85+
86+
General questions should be handled through the
87+
`QuantStack/Lobby <https://matrix.to/#/#QuantStack_Lobby:gitter.im>`_ instead of
88+
the issue tracker. The maintainers there will answer or ask you to file an issue
89+
if you've tripped over a bug.
90+
91+
How to Suggest a Feature or Enhancement
92+
---------------------------------------
93+
94+
If you find yourself wishing for a feature that doesn't exist in
95+
JupyterLab-URDF, you are probably not alone. There are bound to be others out
96+
there with similar needs. Many of the features that JupyterLab-URDF has today
97+
have been added because our users saw the need. Open an issue on our [issues list](https://github.com/jupyter-robotics/JupyterLab-URDF/issues) on GitHub which includes the following:
98+
99+
#. A description of the feature you would like to see
100+
#. Why do you need it?
101+
#. How should it work?
102+
103+
Code Review Process
104+
-------------------
105+
106+
Any change to resources in this repository must be through pull requests. This
107+
applies to all changes to documentation, code, binary files, etc. No pull
108+
request can be merged without being reviewed.
109+
110+
The core team looks at Pull Requests on a regular basis and provides feedback
111+
after each review. Once feedback has been given, we expect responses within
112+
four weeks. After the four weeks have elapsed, we may close the pull request if
113+
it isn't showing any activity.
114+
115+
A pull request will be merged once all the feedback has been addressed and there
116+
are no objections by any of the committers.
117+
118+
Community
119+
---------
120+
121+
You can chat with the core team on
122+
`QuantStack/Lobby <https://matrix.to/#/#QuantStack_Lobby:gitter.im>`_. We try to
123+
answer all questions within 48 hours.

0 commit comments

Comments
 (0)