Skip to content

docs: update contributing guide and developer documentation#838

Open
bimakw wants to merge 1 commit intoNethermindEth:mainfrom
bimakw:docs/update-contributing-734
Open

docs: update contributing guide and developer documentation#838
bimakw wants to merge 1 commit intoNethermindEth:mainfrom
bimakw:docs/update-contributing-734

Conversation

@bimakw
Copy link
Copy Markdown

@bimakw bimakw commented Jan 7, 2026

Summary

  • Created new CONTRIBUTING.md with updated prerequisites, setup instructions, testing/linting commands, and PR guidelines
  • Updated docs/developers.md with current project structure and Makefile commands
  • Updated docs/README.md with links to new documentation

Changes

  • CONTRIBUTING.md: New file with Go 1.25+ requirements, make commands (make mock-test, make lint), and contribution workflow
  • docs/developers.md: Reflects current package structure and development workflow
  • docs/README.md: Added navigation links to new docs

Closes #734

- Add CONTRIBUTING.md with setup, testing, and PR guidelines
- Add docs/developers.md with project structure and workflow
- Update docs/README.md with links to new documentation

Closes NethermindEth#734
@thiagodeev
Copy link
Copy Markdown
Collaborator

Hey @bimakw! Thanks for all your contributions.
Sorry, I'll take some time until I review your PRs. We are completely focused on the next release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Update contributing guide & developers.md in the docs/ folder

2 participants