Skip to content

(doc) update CONTRIBUTING.md to clarify roles/expectations#1037

Open
isc-tleavitt wants to merge 3 commits intomainfrom
2026-contributing-guidelines
Open

(doc) update CONTRIBUTING.md to clarify roles/expectations#1037
isc-tleavitt wants to merge 3 commits intomainfrom
2026-contributing-guidelines

Conversation

@isc-tleavitt
Copy link
Contributor

@isc-tleavitt isc-tleavitt commented Jan 13, 2026

Our intent here is to clarify the roles/expectations for InterSystems and community contributors.

Resolves #1051

@isc-tleavitt
Copy link
Contributor Author

isc-tleavitt commented Jan 13, 2026

@AshokThangavel I'd appreciate your feedback on this too - I'd like to be able to set proper expectations. We appreciate your ideas and contributions and having clearer guidelines should help us stay on the same page. (And will also help in the event we're fortunate enough to have more community contributors come along.)

Also to that end, I'd like to start up a weekly office hours / community discussion meeting around IPM. Feel free to drop me an email at tleavitt@intersystems.com and I can include you.

@AshokThangavel
Copy link
Contributor

Hello @isc-tleavitt
Thank you for sharing this; I truly appreciate it. These clarifications are very clear and helpful, especially the target timelines for reviews and the 'spec first' approach for new features. It shows that you value the community's time and effort by ensuring we don’t work on things that might not align with the roadmap. The 'help wanted' label is also a great addition to help us identify where we can provide the most value

From a contributor’s perspective, I have a few suggestions to make this process even smoother:

  1. Feature Spec Template: Could we add a standardized "Feature Spec Template" to the repository? Providing a simple structure—including sections for Description, Proposed Changes, Usage Examples, and Initial Suggestions/Thoughts—would help community members provide the exact technical details you need upfront.
  2. Dedicated Style Guide: It would be very helpful to have a STYLE_GUIDE.md or a specific section for coding standards. Since code styling is also a common focus during PR reviews, having a clear reference for naming conventions and formatting would help contributors align with your expectations before submitting. This would significantly speed up the review cycle for everyone.
  3. Initial Response Target: While I respect the team's busy schedule, it would be encouraging to have a general target for an initial response to "Needs Spec" discussions. Even a brief acknowledgement lets contributors know their proposal is on the radar and keeps the momentum going.

Thanks again for the invitation to provide feedback and for setting up the office hours! I’d love to participate and will send you an email shortly so you can include me in the meeting invite.

Thank you!

isc-dchui
isc-dchui previously approved these changes Feb 2, 2026
Copy link
Collaborator

@isc-dchui isc-dchui left a comment

Choose a reason for hiding this comment

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

Looks good to me (I also added a style guide section)

@AshokThangavel
Copy link
Contributor

Hi @isc-dchui
While updating the CONTRIBUTING.md guidelines, I’d like to incorporate your suggestion regarding integration tests from pull request comment.

It's easier to just build your own modules and dependencies for integration tests.
use tests\integration_tests\Test\PM\Integration\_data\uninstall as the reference .

Thank you!

@isc-dchui
Copy link
Collaborator

isc-dchui commented Feb 4, 2026

Added a section on test module creation and clarified the recommendations around developing in Docker containers

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.

Error running setup() method

4 participants