Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on models affecting or being affected by signals #1996

Closed
2 tasks
vickyszuchin opened this issue Apr 8, 2024 · 1 comment · Fixed by #2151
Closed
2 tasks

Add documentation on models affecting or being affected by signals #1996

vickyszuchin opened this issue Apr 8, 2024 · 1 comment · Fixed by #2151
Assignees
Labels

Comments

@vickyszuchin
Copy link

vickyszuchin commented Apr 8, 2024

Issue description

We have code, especially for Users and Contacts that makes changes by using django signals. However this is very hard for new developers to find out as it's very buried in the code. The goal here is to make sure a new developer would easily know that we 1.) use signals. 2) where we use it. 3) how we use it. 4) when looking at the given model affected by the signal its clearly documented what is relying on the signal.

Acceptance criteria

  • Add documentation in our developer readme (or a similiar readme) to explain that we are using signals on some models (answer why, how and where).
  • On models affecting or being affected by signals, add documentation on what is being changed by a signal and when (and any other useful info deemed worthwhile to add)

Additional context

Discussed in engineer huddle on 4/8/2024. See notes.

Links to other issues

No response

@vickyszuchin vickyszuchin added dev docs Documentation labels Apr 8, 2024
@abroddrick abroddrick added pulled in pulled into a sprint after sprint planning and removed pulled in pulled into a sprint after sprint planning labels May 1, 2024
@vickyszuchin vickyszuchin removed the pulled in pulled into a sprint after sprint planning label May 7, 2024
@vickyszuchin
Copy link
Author

Removed "pulled in" label since this is planned for the upcoming sprint (starting on 5/8).

@zandercymatics zandercymatics self-assigned this May 7, 2024
zandercymatics added a commit that referenced this issue May 13, 2024
…affected-by-signals

Ticket #1996: Add documentation on models affected by signals
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

4 participants