FIREFLY-1511: Add Code of conduct and Contribution guidelines #1692
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaladh-singhal
commented
Jan 24, 2025
| - We pledge to help the entire community follow the code of conduct, and to not | ||
| remain silent when we see violations of the code of conduct. We will take | ||
| action when members of our community violate this code such as | ||
| contacting [email protected] (all emails sent to this address will be |
There was a problem hiding this comment.
Do we have any dedicated email at IPAC for CoC violations?
jaladh-singhal
commented
Jan 24, 2025
|
|
||
| ### Reporting a Bug | ||
|
|
||
| Firefly is in active development. It's no surprise that you may encounter something that doesn't work for your use case. Or maybe you have some suggestions about how we can improve some functionality. Feel free to share any of it with us by [opening an issue](https://docs.github.com/en/github/managing-your-work-on-github/creating-an-issue) at [Firefly Github Issues](https://github.com/Caltech-IPAC/firefly/issues). |
There was a problem hiding this comment.
I know we don't use Github issues as much but public users of firefly seem to be taking this route, and this guide is intended for people like them in open source community
jaladh-singhal
commented
Jan 24, 2025
Comment on lines
+45
to
+47
| Currently, Firefly tracks development priorities and tasks through Jira, which is internal to us, rather than through public GitHub issues. As a result, we don't have "good-first" or "easy" labeled issues to invite code contributions from new contributors. However, that shouldn't discourage you from contributing! As a new user, you have a better perspective on where our documentation lacks, and you can edit it to make it better, as described in the previous section. | ||
|
|
||
| If you've [set up Firefly locally](https://github.com/Caltech-IPAC/firefly/tree/dev?tab=readme-ov-file#setup) and have some familiarity with the codebase, we encourage you to contribute by adding features you'd find useful or fixing issues that affect your workflow. Your contributions will be invaluable to improve open-sourced Firefly for other users as well. |
There was a problem hiding this comment.
Firefly differs here compared to other open sourced software, I tried to write it to communicate that limitation to non-IPAC/Rubin contributors while sharing ways in which they can make PRs.
Open to suggestions to rewrite it better.
jaladh-singhal
commented
Jan 24, 2025
|
|
||
| ### Spreading the Word of Mouth | ||
|
|
||
| If you find Firefly helpful, you can share it with your peers, colleagues, and anyone who can benefit from Firefly. If you've used Firefly in your research, please acknowledge us. By telling other people about how Firefly helped you, you'll help us in turn, extending Firefly's impact. And we would absolutely love it if you give us a shout-out on IPAC's social media: [LinkedIn](https://www.linkedin.com/showcase/ipac-at-caltech/) | [Twitter](https://x.com/caltechipac). |
There was a problem hiding this comment.
Do we have any DOI for firefly that we can put for "acknowledge us"?
At TARDIS, we have a github actions setup to make zenodo release with each new release of code and generate a citation format (.CFF) from it that users can use to cite.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes FIREFLY-1511
See rendered version of these 2 markdown docs here:
Firefly Code of Conduct (CoC) is adapted from Astropy since every other project seems to be reusing Astropy's CoC. But these projects differ on Contribution guidelines - I adapted those of TARDIS for Firefly, given that we wanted to keep it high-level without delving into technical details which needs a lot more time.
All options that I considered (for inspiration) are: