Skip to content

Feature/developer guide#83

Open
goyalpalak18 wants to merge 33 commits intohyphae:masterfrom
goyalpalak18:feature/developer-guide
Open

Feature/developer guide#83
goyalpalak18 wants to merge 33 commits intohyphae:masterfrom
goyalpalak18:feature/developer-guide

Conversation

@goyalpalak18
Copy link

I noticed the project was missing a dedicated setup guide, which makes it hard for new contributors to get started.

I’ve added DEVELOPER_SETUP.md with:

  • Step-by-step installation instructions (Mac/Linux).
  • Prerequisites (Java, Maven, Python).
  • Common troubleshooting tips (like port conflicts).

Hope this helps! Fixes #66.

WillSams and others added 30 commits February 7, 2025 09:53
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Bill Bensing <bill@billbensing.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: Will Sams <will@samswebs.com>
Signed-off-by: AXM Software <35903292+axmsoftware@users.noreply.github.com>
Signed-off-by: Souradip Pal <souradip1000@gmail.com>
Signed-off-by: Venkata Sai <116882464+Venkata-Sai-Vishwanath-robo@users.noreply.github.com>
…patch-1

Improve Makefile help target for better contributor guidance
Update README.md Technology spelling
Signed-off-by: Subhramit Basu <subhramit.bb@live.in>
…y: Akarsh Sahlot <akarshsahlot8@gmail.com>

- Restructure content to match LF Energy CoMPAS format
- Move Quick Start section to top for better accessibility
- Organize system components into logical groups
- Consolidate support and community resources
- Add proper badges section
- Maintain all essential technical information

Signed-off-by: Akarsh Sahlot <akarshsahlot8@gmail.com>

Signed-off-by: Akarsh Sahlot <122122123+AkarshSahlot@users.noreply.github.com>
docs: reorganize README.md to follow LF Energy standards Signed-off-b…
docs: reorganize README.md to follow LF Energy project standards
docs: fix broken links and remove unverified content

Remove fictional testimonials, non-existent documentation links, 
and unverified statistics while maintaining professional structure.

Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>

Signed-off-by: Akarsh Sahlot <122122123+AkarshSahlot@users.noreply.github.com>
Updated README.md to follow LF Energy CoMPAS format,removed broken links and removed MongoDB as a requirement
Adjusted permissions and action versions

Signed-off-by: AXM Software <35903292+axmsoftware@users.noreply.github.com>
Update Scorecard workflow dependencies and permissions
Updated retention days for SARIF file upload and changed CodeQL action version.

Signed-off-by: AXM Software <35903292+axmsoftware@users.noreply.github.com>
Modify scorecard workflow for SARIF retention and version
Added  OpenSSF Scorecard Badge. Removed introductory tagline and image from README.

Signed-off-by: AXM Software <35903292+axmsoftware@users.noreply.github.com>
Update README to add OpenSSF Scorecard Badge
Signed-off-by: Palak Goyal <palakgoyal@Palaks-MacBook-Pro.local>
Signed-off-by: goyalpalak18 <goyalpalak1806@gmail.com>
Signed-off-by: goyalpalak18 <goyalpalak1806@gmail.com>
Signed-off-by: goyalpalak18 <goyalpalak1806@gmail.com>
@goyalpalak18 goyalpalak18 force-pushed the feature/developer-guide branch from 316382d to 07e09bd Compare February 3, 2026 16:33
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.

9 participants