Skip to content

Enhance README with detailed project information - #1159

Open
maariaEn wants to merge 2 commits into
openmainframeproject:mainfrom
maariaEn:patch-2
Open

maariaEn wants to merge 2 commits into
openmainframeproject:mainfrom
maariaEn:patch-2

Conversation

@maariaEn

Copy link
Copy Markdown

factored the root README.md to serve as a comprehensive hub for contributors.

This update transforms it into a developer guide that includes:

  • A clear mapping of the repository layout.
  • Explicit instructions on updating site data (CSV files) vs. markdown pages.
  • Local development setup instructions (Jekyll, Bundler, Ruby versioning, and pre-commit hooks).
  • Clarified contribution workflows, including DCO sign-off requirements and links to issue templates.

factored the root README.md to serve as a comprehensive hub for contributors. 

 This update transforms it into a developer guide that includes:
- A clear mapping of the repository layout.
- Explicit instructions on updating site data (CSV files) vs. markdown pages.
- Local development setup instructions (Jekyll, Bundler, Ruby versioning, and pre-commit hooks).
- Clarified contribution workflows, including DCO sign-off requirements and links to issue templates.

Signed-off-by: Zaba.Arcymag <spoksziomek@gmail.com>

This branch has not been deployed

No deployments
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.

1 participant