Updated the contributing guide

[pritkc]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Example
• Documentation

Description

Added details to existing contribution guide as mentioned under #148

Related Issues & Documents

• Closes Feature Request: Comprehensive Contributing Guide for MOLE #148

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes.

Added/updated tests?

_We encourage you to test all code included with MOLE, including examples.

• Yes
• No, and this is why: please replace this line with details on why tests
  have not been included
• I need help with writing tests

Read Contributing Guide and Code of Conduct

• I have read and followed the Contributing Guide and the Code of Conduct

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

[mdumett]

It looks good to me.

[jcastillo001]

I noticed and I agree with Valeria. Thanks for bringing that up. We should add Jared and Valeria. Prof. Jose E. Castillo, Ph.D. Director/Professor Computational Science Research Center San Diego State University Google Scholar <https://scholar.google.com/citations?user=6qGWVfkAAAAJ&hl=en> www.csrc.sdsu.edu

…

On Tue, Jun 10, 2025 at 10:27 AM Valeria Barra ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In CONTRIBUTING.md <#151 (comment)>: > + - Creation of comprehensive examples and tutorials + - Documentation and mathematical framework development + - Conceptualization of new features or mathematical approaches + - Code review, testing, and validation + - Community building and user support + +2. **Maintain and support their contributions** over time, including: + - Responding to issues related to their contributions + - Updating code to maintain compatibility + - Providing ongoing documentation and support + +### Recognition Process + +- **Automatic Recognition**: Maintainers will monitor contributions and add qualifying contributors to the `AUTHORS` file +- **Self-Nomination**: If you believe your contributions meet the authorship criteria but haven't been acknowledged, please: + - Email the maintainers at ***@***.******@***.***), ***@***.******@***.***), or ***@***.******@***.***) Thank you all for reviewing. @csrc-sdsu/the-moles <https://github.com/orgs/csrc-sdsu/teams/the-moles> I would personally like to update the list of contact email addresses here. I think we should keep someone who is currently active in the project maintenance. Please advice. — Reply to this email directly, view it on GitHub <#151 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATWZMCLHWABOUWGC72XCSVL3C4IQ3AVCNFSM6AAAAAB6W24NSGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSMJUGQ3TIMBUGQ> . You are receiving this because you are on a team that was mentioned.Message ID: ***@***.***>

[jcastillo001]

I agree! Prof. Jose E. Castillo, Ph.D. Director/Professor Computational Science Research Center San Diego State University Google Scholar <https://scholar.google.com/citations?user=6qGWVfkAAAAJ&hl=en> www.csrc.sdsu.edu

…

On Tue, Jun 10, 2025 at 10:53 AM Valeria Barra ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In CONTRIBUTING.md <#151 (comment)>: > +--- + +## Getting Help + +### Resources + +1. **Documentation**: Read the [online documentation](https://mole-docs.readthedocs.io/) +2. **Examples**: Study existing examples for patterns and best practices +3. **Issues**: Check [GitHub issues](https://github.com/csrc-sdsu/mole/issues) for known problems +4. **Discussions**: Use GitHub Discussions for questions and ideas + +### Contact + +For questions or support: + +- **Email**: ***@***.******@***.***), ***@***.******@***.***), ***@***.******@***.***) ⬇️ Suggested change -- **Email**: ***@***.******@***.***), ***@***.******@***.***), ***@***.******@***.***) ------------------------------ In CONTRIBUTING.md <#151 (comment)>: > + - Creation of comprehensive examples and tutorials + - Documentation and mathematical framework development + - Conceptualization of new features or mathematical approaches + - Code review, testing, and validation + - Community building and user support + +2. **Maintain and support their contributions** over time, including: + - Responding to issues related to their contributions + - Updating code to maintain compatibility + - Providing ongoing documentation and support + +### Recognition Process + +- **Automatic Recognition**: Maintainers will monitor contributions and add qualifying contributors to the `AUTHORS` file +- **Self-Nomination**: If you believe your contributions meet the authorship criteria but haven't been acknowledged, please: + - Email the maintainers at ***@***.******@***.***), ***@***.******@***.***), or ***@***.******@***.***) ⬇️ Suggested change - - Email the maintainers at ***@***.******@***.***), ***@***.******@***.***), or ***@***.******@***.***) + - Email the maintainers at ***@***.******@***.***), ***@***.******@***.***), ***@***.******@***.***), ***@***.******@***.***), or ***@***.******@***.***). @pritkc <https://github.com/pritkc> , please update these email addresses here and also in our Code of Conduct <https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md#enforcement>. Thank you! — Reply to this email directly, view it on GitHub <#151 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATWZMCMGIFHNTDAU2ZMTCS33C4LTLAVCNFSM6AAAAAB6W24NSGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSMJUGU3DENRZGU> . You are receiving this because you are on a team that was mentioned.Message ID: ***@***.***>