Skip to content

add a Contributing, Code of Conduct and Security documents#5

Open
shravanngoswamii wants to merge 4 commits intomainfrom
sg-Contributing
Open

add a Contributing, Code of Conduct and Security documents#5
shravanngoswamii wants to merge 4 commits intomainfrom
sg-Contributing

Conversation

@shravanngoswamii
Copy link
Copy Markdown
Member

Yes, it's possible to have a organization wide guides, I can't find any official github docs source mentioning this, I am sure I read this somewhere few months back. I am unable to find that right now. But I found the example:

P4 Language (I haven't heard of before) have CONTRIBUTING.md in .github repo and it appears in all the repos which does have there own CONTRIBUTING.md, see: https://github.com/p4lang/p4mlir-incubator?tab=contributing-ov-file

Same applies to Code of Conduct and Security documents

Copy link
Copy Markdown
Member

@penelopeysm penelopeysm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This all reads well, I have some minor comments.

Just so that I'm aware: where is this text taken from (or did you write it yourself)?

shravanngoswamii and others added 2 commits April 7, 2026 15:58
Co-authored-by: Penelope Yong <penelopeysm@gmail.com>
Co-authored-by: Penelope Yong <penelopeysm@gmail.com>
@shravanngoswamii
Copy link
Copy Markdown
Member Author

Just so that I'm aware: where is this text taken from (or did you write it yourself)?

It's a mix of many source, gumroad, llvm, SciML, and many more...
Code of Conduct is from https://policies.python.org/python.org/code-of-conduct/, https://www.debian.org/code_of_conduct, https://www.djangoproject.com/conduct/, https://rust-lang.org/policies/code-of-conduct/, https://www.apache.org/foundation/policies/conduct, https://julialang.org/community/standards/

Overall, it's not totally my wording, picked sentences from many sources and reworded them here.

And for Security, we should provide guides from https://github.com/JuliaLang/SecurityAdvisories.jl but it's not stable yet so let's wait few months to add that

Copy link
Copy Markdown
Member

@penelopeysm penelopeysm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with the current state. I think it's worth considering whether it should also somehow be on the contributing section of the docs page but that's ofc in a different repo

@shravanngoswamii
Copy link
Copy Markdown
Member Author

I think it's worth considering whether it should also somehow be on the contributing section of the docs page but that's ofc in a different repo

Ahmm, that's already very well written, thanks to you! Is this even required there anymore? This is general org wide repo scope guide for usually external contributors, right?

@penelopeysm
Copy link
Copy Markdown
Member

The docs site is also for external contributors! I think there are portions that should probably be repeated, especially the bits on AI usage, which the docs site doesn't say anything about. But it's true, some of the content might be repeated.

@yebai yebai requested review from sunxd3 and removed request for yebai April 7, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants