Add contribution guidelines by samithkavishke · Pull Request #1354 · wso2/product-ballerina-integrator

samithkavishke · 2025-09-24T03:06:01Z

Purpose

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

RadCod3 · 2025-09-24T04:04:59Z

CONTRIBUTING.md

+## Development Setup
+
+### Prerequisites
+- **Node.js**: >=20.0.0 <23.0.0


The required node version mentioned in https://github.com/wso2/vscode-extensions/#prerequisites is >= 22. Shall we double check this?

RadCod3 · 2025-09-24T04:08:10Z

CONTRIBUTING.md

+
+### Prerequisites
+- **Node.js**: >=20.0.0 <23.0.0
+- **Package Manager**: Rush.js with pnpm


Should we guide the user to install rush as well? WDYT?.
Alternatively, we can point them at the prerequisites mentioned in https://github.com/wso2/vscode-extensions/#prerequisites which does have the steps to install all the prerequisites.

dan-niles · 2025-09-24T04:01:21Z

CONTRIBUTING.md

+
+## Repository Overview
+
+This repository (`product-ballerina-integrator`) is primarily used for **issue tracking** for the WSO2 Ballerina Integrator product. The actual development happens in separate repositories:


Suggested change

This repository (`product-ballerina-integrator`) is primarily used for **issue tracking** for the WSO2 Ballerina Integrator product. The actual development happens in separate repositories:

This repository (`product-ballerina-integrator`) is primarily used for **issue tracking** for the WSO2 Integrator: BI product. The actual development happens in separate repositories:

Other places might have to be updated as well

dan-niles · 2025-09-24T04:02:44Z

CONTRIBUTING.md

@@ -0,0 +1,175 @@
+# Contributing to WSO2 Ballerina Integrator
+
+Thank you for your interest in contributing to WSO2 Ballerina Integrator! This guide will help you understand how to contribute to different parts of the project.


Suggested change

Thank you for your interest in contributing to WSO2 Ballerina Integrator! This guide will help you understand how to contribute to different parts of the project.

Thank you for your interest in contributing to WSO2 Integrator: BI! This guide will help you understand how to contribute to different parts of the project.

dan-niles · 2025-09-24T04:11:13Z

CONTRIBUTING.md

+npm run e2e-test
+```
+
+### Backend Development Setup


Shall we also include setup instructions (similar to the Initial Setup section above for the frontend) for the language server here as well?

dan-niles · 2025-09-24T04:18:57Z

CONTRIBUTING.md

+# Watch mode for development (from individual package directories)
+cd workspaces/ballerina/ballerina-visualizer
+npm start
+


Shall we also mention that they have to select Ballerina & BI Extensions option from the debug menu and run it to view the extension development host?

Copilot

Pull Request Overview

Adds contribution guidelines and surfaces them from the README to help new contributors discover how to work across the frontend and backend repos.

Introduces a comprehensive CONTRIBUTING.md with setup, contribution flows, and architecture guidance
Updates README with a Contributing section linking to the new guide

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
README.md	Adds a Contributing section linking to CONTRIBUTING.md and outlining what it covers
CONTRIBUTING.md	New, detailed contribution guide covering repo overview, setup, best practices, and support channels

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-18T08:43:02Z

CONTRIBUTING.md

+- **Go to Definition**: Navigate to symbol definitions
+- **Diagnostics**: Real-time error and warning reporting
+- **Code Actions**: Quick fixes and refactoring suggestions
+- **Goto Implementation**: Find interface implementations


Correct 'Goto Implementation' to 'Go to Implementation' for consistency with 'Go to Definition' and standard terminology.

Suggested change

- **Goto Implementation**: Find interface implementations

- **Go to Implementation**: Find interface implementations

Copilot · 2025-10-18T08:43:02Z

CONTRIBUTING.md

+# Install dependencies
+rush install
+
+# Build all packages
+rush build


Before using 'rush install', add an explicit step to install the Rush CLI so new contributors don't hit a 'rush: command not found' error. Example: 'npm install -g @microsoft/rush' (or note that 'npx @microsoft/rush install' can be used without a global install).

Copilot · 2025-10-18T08:43:02Z

CONTRIBUTING.md

+- **Visual Components**: `workspaces/ballerina/ballerina-visualizer/`
+- **Core Libraries**: `workspaces/ballerina/ballerina-core/`
+- **RPC Client**: `workspaces/ballerina/ballerina-rpc-client/`
+- **Diagram Components**: `workspaces/ballerina/sequence-diagram/`, `type-diagram/`, etc.


The second path is missing the 'workspaces/ballerina/' prefix for consistency and clarity. Suggested: 'workspaces/ballerina/type-diagram/'.

Suggested change

- **Diagram Components**: `workspaces/ballerina/sequence-diagram/`, `type-diagram/`, etc.

- **Diagram Components**: `workspaces/ballerina/sequence-diagram/`, `workspaces/ballerina/type-diagram/`, etc.

Copilot · 2025-10-18T08:43:03Z

CONTRIBUTING.md

+
+## Code of Conduct
+
+Please note that this project follows WSO2's Code of Conduct. By participating in this project, you agree to abide by its terms.


Provide a direct link to the Code of Conduct so contributors can easily find it. For example: 'Please note that this project follows WSO2's Code of Conduct ...' (or link to the official WSO2 page if applicable).

Suggested change

Please note that this project follows WSO2's Code of Conduct. By participating in this project, you agree to abide by its terms.

Please note that this project follows WSO2's [Code of Conduct](https://wso2.com/code-of-conduct/). By participating in this project, you agree to abide by its terms.

Copilot · 2025-10-18T08:43:03Z

CONTRIBUTING.md

+
+## License
+
+By contributing to WSO2 Ballerina Integrator, you agree that your contributions will be licensed under the Apache License 2.0.


Link to the license text to remove ambiguity. For example: '... licensed under the Apache License 2.0' (or link to https://www.apache.org/licenses/LICENSE-2.0 if there is no local LICENSE file).

Suggested change

By contributing to WSO2 Ballerina Integrator, you agree that your contributions will be licensed under the Apache License 2.0.

By contributing to WSO2 Ballerina Integrator, you agree that your contributions will be licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

samithkavishke added 3 commits September 24, 2025 08:34

Add contribution guidelines

428a37f

Correct contribution guidelines

1fda29b

Add contributing.md links to the readme file

fc55dcb

samithkavishke requested a review from anupama-pathirage September 24, 2025 03:14

RadCod3 reviewed Sep 24, 2025

View reviewed changes

dan-niles reviewed Sep 24, 2025

View reviewed changes

NipunaRanasinghe requested a review from Copilot October 18, 2025 08:41

Copilot AI reviewed Oct 18, 2025

View reviewed changes


		## Repository Overview

		This repository (`product-ballerina-integrator`) is primarily used for issue tracking for the WSO2 Ballerina Integrator product. The actual development happens in separate repositories:

		@@ -0,0 +1,175 @@
		# Contributing to WSO2 Ballerina Integrator

		Thank you for your interest in contributing to WSO2 Ballerina Integrator! This guide will help you understand how to contribute to different parts of the project.

	- Goto Implementation: Find interface implementations
	- Go to Implementation: Find interface implementations

	- Diagram Components: `workspaces/ballerina/sequence-diagram/`, `type-diagram/`, etc.
	- Diagram Components: `workspaces/ballerina/sequence-diagram/`, `workspaces/ballerina/type-diagram/`, etc.


		## Code of Conduct

		Please note that this project follows WSO2's Code of Conduct. By participating in this project, you agree to abide by its terms.


		## License

		By contributing to WSO2 Ballerina Integrator, you agree that your contributions will be licensed under the Apache License 2.0.

Comments

Conversation

samithkavishke commented Sep 24, 2025

Purpose

Goals

Approach

User stories

Release note

Documentation

Training

Certification

Marketing

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

Uh oh!

RadCod3 Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

RadCod3 Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

dan-niles Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

dan-niles Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

dan-niles Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

dan-niles Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

dan-niles Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants