Skip to content

Commit f5a9161

Browse files
authored
DOCS: Update developer's guide with major changes note
Added a note regarding major changes and discussions with maintainers.
1 parent b540792 commit f5a9161

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,9 @@ Developer's Guide
128128
=================
129129

130130
Please refer to the developer's guide in the `Wiki page <https://github.com/AdvancedPhotonSource/pty-chi/wiki>`_
131-
for more information on how to contribute to the project.
131+
for more information on how to contribute to the project.
132+
133+
🛑 **For major changes such as adding a new reconstructor or those involving extensive structural changes to the codebase,
134+
please first discuss with the maintainers by creating an issue. Consider creating a new package inheriting Pty-Chi's reconstructors
135+
and data structures for experimental features and algorithms. See**
136+
`Developer’s guide: Extending Pty-Chi with external algorithm packages <https://github.com/AdvancedPhotonSource/pty-chi/wiki/Developer%27s-guide:-Extending-Pty%E2%80%90chi-with-external-algorithm-packages>`_.

0 commit comments

Comments
 (0)