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
+103Lines changed: 103 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -560,4 +560,107 @@ By contributing to MOLE, you agree that your contributions will be licensed unde
560
560
561
561
---
562
562
563
+
## Authorship and Recognition
564
+
565
+
MOLE contains components authored by many individuals from the computational science community. We believe it is essential that contributors receive appropriate recognition through both informal acknowledgment and academically-recognized credit systems such as publications and citations.
566
+
567
+
### Authorship Criteria
568
+
569
+
Status as a named author in MOLE publications, the user manual, and DOI-bearing archives will be granted to those who:
570
+
571
+
1.**Make significant contributions to MOLE** in any of the following areas:
572
+
- Implementation of core functionality (operators, boundary conditions, utilities)
573
+
- Creation of comprehensive examples and tutorials
574
+
- Documentation and mathematical framework development
575
+
- Conceptualization of new features or mathematical approaches
576
+
- Code review, testing, and validation
577
+
- Community building and user support
578
+
579
+
2.**Maintain and support their contributions** over time, including:
580
+
- Responding to issues related to their contributions
581
+
- Updating code to maintain compatibility
582
+
- Providing ongoing documentation and support
583
+
584
+
### Recognition Process
585
+
586
+
-**Automatic Recognition**: Maintainers will monitor contributions and add qualifying contributors to the `AUTHORS` file
587
+
-**Self-Nomination**: If you believe your contributions meet the authorship criteria but haven't been acknowledged, please:
588
+
- Email the maintainers at [johnnycorbino@gmail.com](mailto:johnnycorbino@gmail.com), [angelboada2@gmail.com](mailto:angelboada2@gmail.com), or [jcastillo@sdsu.edu](mailto:jcastillo@sdsu.edu)
589
+
- Create a GitHub issue describing your contributions
590
+
-**Periodic Review**: The maintainer team regularly reviews the contributor list to ensure proper recognition
591
+
592
+
### Publication Guidelines
593
+
594
+
#### MOLE Software Publications
595
+
596
+
Authors of publications about MOLE as a whole, including:
597
+
- Software papers and technical reports
598
+
- DOI-bearing software archives
599
+
- Major release announcements
600
+
- Comprehensive method descriptions
601
+
602
+
**shall offer co-authorship to all individuals listed in the `AUTHORS` file** at the time of submission.
603
+
604
+
#### Publications Using MOLE Features
605
+
606
+
Authors of publications that describe **specific MOLE contributions or new features** shall:
607
+
1. Review the `AUTHORS` file to identify relevant contributors
608
+
2. Evaluate the intellectual contributions of listed authors to the specific work
609
+
3. Offer co-authorship to those who made significant intellectual contributions to the featured work
610
+
4. At minimum, acknowledge MOLE and cite appropriate references
611
+
612
+
#### Publications Using MOLE for Research
613
+
614
+
**No co-authorship expectation** exists for those publishing research that uses MOLE as a computational tool (versus creating new features in MOLE). However:
615
+
616
+
-**Citation**: Please cite MOLE appropriately (see [CITATION.cff](../CITATION.cff))
617
+
-**Acknowledgment**: Consider acknowledging significant support or advice received from MOLE developers
618
+
-**Judgment**: Use your best judgment regarding the significance of support received in developing your use case and interpreting results
619
+
620
+
### Citing MOLE
621
+
622
+
When using MOLE in your research, please cite:
623
+
624
+
```bibtex
625
+
@misc{mole,
626
+
title = {{MOLE}: Mimetic Operators Library Enhanced},
627
+
author = {[See AUTHORS file for complete list]},
628
+
url = {https://github.com/csrc-sdsu/mole},
629
+
note = {Version X.X.X},
630
+
year = {2024}
631
+
}
632
+
```
633
+
634
+
For specific mathematical methods or operators, also cite the relevant publications listed in our [documentation](https://mole-docs.readthedocs.io/).
635
+
636
+
### Examples of Significant Contributions
637
+
638
+
To clarify what constitutes "significant contributions," here are examples:
639
+
640
+
**Core Development:**
641
+
- Implementing new differential operators or boundary conditions
642
+
- Adding support for new grid types or geometries
643
+
- Developing new mathematical formulations
644
+
- Creating fundamental algorithmic improvements
645
+
646
+
**Documentation and Education:**
647
+
- Writing comprehensive tutorials or guides
648
+
- Creating educational examples with mathematical background
649
+
- Developing API documentation for major components
650
+
- Contributing to the mathematical framework documentation
651
+
652
+
**Testing and Validation:**
653
+
- Developing comprehensive test suites
654
+
- Conducting convergence studies and validation
655
+
- Cross-platform compatibility work
656
+
- Performance optimization and benchmarking
657
+
658
+
**Community Building:**
659
+
- Mentoring new contributors
660
+
- Organizing workshops or educational events
661
+
- Significant bug reporting and issue management
662
+
- Long-term maintenance and support
663
+
664
+
---
665
+
563
666
Thank you for contributing to MOLE! Your contributions help advance computational science and benefit the entire research community.
0 commit comments