You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,21 @@
1
+
## Community Guidelines
2
+
3
+
We strive to maintain a welcoming, respectful, and inclusive community. All contributors—whether opening issues, submitting pull requests, reviewing code, or participating in discussions—are expected to follow these guidelines.
4
+
5
+
- Be respectful and considerate of others.
6
+
- Assume good intent and be patient, especially with newcomers.
7
+
- Keep feedback constructive and focused on the work, not the person.
8
+
- Communicate clearly and professionally.
9
+
- Respect maintainers’ time and decisions.
10
+
11
+
Harassment, discrimination, or abusive behavior of any kind will not be tolerated.
12
+
13
+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
14
+
15
+
### Reporting concerns
16
+
If you experience or witness behavior that violates these guidelines or the Code of Conduct, please contact the project maintainers privately.
17
+
18
+
1
19
# Contributing
2
20
3
21
Contributions are welcome and greatly appreciated!
Copy file name to clipboardExpand all lines: README.rst
+21-9Lines changed: 21 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,19 +59,19 @@ The following links are useful for new starters:
59
59
60
60
- `The PyAutoLens readthedocs <https://pyautolens.readthedocs.io/en/latest>`_: which includes `an overview of PyAutoLens's core features <https://pyautolens.readthedocs.io/en/latest/overview/overview_1_start_here.html>`_, `a new user starting guide <https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautolens.readthedocs.io/en/latest/installation/overview.html>`_.
61
61
62
-
- `The introduction Jupyter Notebook on Binder <https://mybinder.org/v2/gh/Jammy2211/autolens_workspace/release?filepath=start_here.ipynb>`_: try **PyAutoLens** in a web browser (without installation).
62
+
- `The introduction Jupyter Notebook on Google Colab <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here.ipynb>`_: try **PyAutoLens** in a web browser (without installation).
63
63
64
64
- `The autolens_workspace GitHub repository <https://github.com/Jammy2211/autolens_workspace>`_: example scripts and the HowToLens Jupyter notebook lectures.
65
65
66
-
Support
67
-
-------
66
+
Community & Support
67
+
-------------------
68
68
69
-
Support for installation issues, help with lens modeling and using **PyAutoLens** is available by
70
-
`raising an issue on the GitHub issues page <https://github.com/Jammy2211/PyAutoLens/issues>`_.
69
+
Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses
70
+
gravitational lensing analysis, and helps troubleshoot problems.
71
71
72
-
We also offer support on the **PyAutoLens** `Slack channel <https://pyautolens.slack.com/>`_, where we also provide the
73
-
latest updates on **PyAutoLens**. Slack is invitation-only, so if you'd like to join send
74
-
an `email <https://github.com/Jammy2211>`_ requesting an invite.
72
+
Slack is invitation-only. If you’d like to join, please send an email requesting an invite.
73
+
74
+
For installation issues, bug reports, or feature requests, please raise an issue on the [GitHub issues page](https://github.com/Jammy2211/PyAutoLens/issues).
75
75
76
76
HowToLens
77
77
---------
@@ -80,4 +80,16 @@ For users less familiar with gravitational lensing, Bayesian inference and scien
80
80
you may wish to read through the **HowToLens** lectures. These teach you the basic principles of gravitational lensing
81
81
and Bayesian inference, with the content pitched at undergraduate level and above.
82
82
83
-
A complete overview of the lectures `is provided on the HowToLens readthedocs page <https://pyautolens.readthedocs.io/en/latest/howtolens/howtolens.html>`_
83
+
A complete overview of the lectures `is provided on the HowToLens readthedocs page <https://pyautolens.readthedocs.io/en/latest/howtolens/howtolens.html>`_
84
+
85
+
Citations
86
+
---------
87
+
88
+
Information on how to cite **PyAutoLens** in publications can be found `on the citations page <https://github.com/Jammy2211/PyAutoLens/blob/main/CITATIONS.rst>`_.
89
+
90
+
Contributing
91
+
------------
92
+
93
+
Information on how to contribute to **PyAutoLens** can be found `on the contributing page <https://github.com/Jammy2211/PyAutoLens/blob/main/CONTRIBUTING.md>`_.
94
+
95
+
Hands on support for contributions is available via our Slack workspace, again please email to request an invite.
0 commit comments