Organization-wide code of conduct and contributing files#17
Organization-wide code of conduct and contributing files#17dpo merged 5 commits intoJuliaSmoothOptimizers:mainfrom
Conversation
Co-authored-by: Dominique <dominique.orban@gmail.com>
|
What really scares me in terms of development is the use of AI agents. |
@MaxenceGollier What information would make it easier for new contributors? |
I remember that it took me a while during my first internship to understand all of this. |
|
@MaxenceGollier I’ll ad 1 and 2 to #19. I think 3 and 4 belong in a general tutorial on contributing to julia projects. We can add a few useful links in a separate document. Does that sound ok? |
|
Yes, this is ready then. |
There was a problem hiding this comment.
Pull request overview
Adds organization-level community documentation to standardize how people contribute and how conduct is enforced across JuliaSmoothOptimizers.
Changes:
- Add a root-level
CONTRIBUTING.mddescribing where to file issues/discussions and linking to solver-creation guidance. - Add a root-level
CODE_OF_CONDUCT.mdbased on Contributor Covenant v2.1, including enforcement contacts.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Introduces contribution and support guidance, with links to issues/discussions and solver tutorial. |
| CODE_OF_CONDUCT.md | Adds a Contributor Covenant-based code of conduct and enforcement/reporting section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement: | ||
| `tangi.migot@gmail.com` and `dominique.orban@gmail.com`. |
There was a problem hiding this comment.
The email addresses are wrapped in inline code formatting, which prevents GitHub from auto-linking them. Consider using plain text or a mailto link so reporters can click/tap to contact the enforcement team more easily.
| `tangi.migot@gmail.com` and `dominique.orban@gmail.com`. | |
| [tangi.migot@gmail.com](mailto:tangi.migot@gmail.com) and [dominique.orban@gmail.com](mailto:dominique.orban@gmail.com). |
| Focused suggestion and requests can also be opened as issues. | ||
| Before opening a pull request, start an issue or a discussion on the topic, please. | ||
|
|
||
| If you want to ask a question that is not suited for a bug report, feel free to start a discussion [here](https://github.com/JuliaSmoothOptimizers/Organization/discussions). |
There was a problem hiding this comment.
The discussion link points to a specific repo path (JuliaSmoothOptimizers/Organization/discussions). If the intent is to use organization-level Discussions, the canonical URL is https://github.com/orgs/JuliaSmoothOptimizers/discussions (also used elsewhere in this repo). Using the wrong URL will 404 or send users to the wrong place.
| If you want to ask a question that is not suited for a bug report, feel free to start a discussion [here](https://github.com/JuliaSmoothOptimizers/Organization/discussions). | |
| If you want to ask a question that is not suited for a bug report, feel free to start a discussion [here](https://github.com/orgs/JuliaSmoothOptimizers/discussions). |
| For our packages, it should be a link like `https://github.com/JuliaSmoothOptimizers/PACKAGE.jl`. | ||
| For our tutorials, you can open an issue here or in <https://github.com/JuliaSmoothOptimizers/JSOTutorials.jl>. | ||
|
|
||
| Focused suggestion and requests can also be opened as issues. |
There was a problem hiding this comment.
Wording/grammar: "Focused suggestion and requests" reads incorrect (singular/plural mismatch). Consider rephrasing to something like "Focused suggestions and requests" or similar for clarity.
| Focused suggestion and requests can also be opened as issues. | |
| Focused suggestions and requests can also be opened as issues. |
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement: | ||
| `tangi.migot@gmail.com` and `dominique.orban@gmail.com`. |
There was a problem hiding this comment.
The enforcement contact is currently listed as two personal email addresses. Consider using a role-based/shared address (or a GitHub contact mechanism) to avoid tying enforcement to individual personal accounts and to reduce ongoing maintenance if responsibilities change.
| `tangi.migot@gmail.com` and `dominique.orban@gmail.com`. | |
| `code-of-conduct@project.org` (or via the repository's contact links on GitHub). |
closes #13
@dpo, @tmigot, @amontoison
This is very basic but we can start from here.
For the issue template and pr template, we can do it in a separate PR, I am not sure that @amontoison wants these but maybe I am wrong.