✨Maintenance: added first draft of copilot instructions #7513
Conversation
This file contains hidden or 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
pcrespov
approved these changes
Apr 11, 2025
|
| 3. **Follow Coding Conventions**: Adhere to the coding conventions outlined in the `docs/coding-conventions.md` file. | ||
| 4. **Test-Driven Development**: Write unit tests for all new functions and features. Use `pytest` for Python and appropriate testing frameworks for Node.js. | ||
| 5. **Environment Variables**: Use environment variables as specified in `docs/env-vars.md` for configuration. Avoid hardcoding sensitive information. | ||
| 6. **Documentation**: Documentation should be minimal and code self explanatory (add the documentation only when the developer asks explicitely) |
There was a problem hiding this comment.
The word 'explicitely' appears to be misspelled; please change it to 'explicitly'.
Suggested change
| 6. **Documentation**: Documentation should be minimal and code self explanatory (add the documentation only when the developer asks explicitely) | |
| 6. **Documentation**: Documentation should be minimal and code self explanatory (add the documentation only when the developer asks explicitly) |
|
|
||
| ## Python-Specific Instructions | ||
| - Always use type hints and annotations to improve code clarity and compatibility with tools like `mypy`. | ||
| - An exception to that rule is in `test_*` functions return type hint must not be added |
There was a problem hiding this comment.
[nitpick] Consider rephrasing for clarity; for example, 'An exception is that test_* functions should not include a return type hint.'
Suggested change
| - An exception to that rule is in `test_*` functions return type hint must not be added | |
| - An exception to this rule is that `test_*` functions should not include return type hints. |
This was referenced Apr 15, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request includes significant updates to the documentation and best practices for using GitHub Copilot in the
osparc-simcorerepository, as well as a minor change to the environment variables documentation.Documentation Updates:
.github/copilot-instructions.mdwith guidelines and best practices for using GitHub Copilot in Python and Node.js projects. This includes general guidelines, Python-specific instructions, Node.js-specific instructions, and Copilot usage tips.Environment Variables Documentation:
docs/env-vars.mdto remove a redundant note about default values for environment variables.What do these changes do?
Related issue/s
How to test
Dev-ops checklist