Skip to content

Contributing section added. PR auto-created. #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emil14 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Contributing section added. PR auto-created. #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
697a5f3
Add Contributing section to README.md with guidelines for issues, pul…
emil14 Mar 7, 2026
4d849f3
Apply PR review feedback to Contributing section
emil14 Mar 7, 2026
835b05c
Update Local Checks bullet per review request
emil14 Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,14 @@

1. Install Neva CLI
2. Run `neva run main`
3. Check `neva.yml` for module config
3. Check `neva.yml` for module config

## Contributing

- **Opening Issues**: Feel free to open GitHub issues for bugs, feature requests, or questions. Please include a clear description, steps to reproduce (for bugs), and any relevant context.

- **Pull Requests**: Fork the repository, create a feature branch, make your changes, and submit a pull request. Ensure your code follows the project's style. If adding new features, consider adding tests where applicable.

- **Local Checks**: Run local checks (for example, tests/lint) before opening a PR.

- **Development Setup**: After forking and cloning, check the `neva.yml` for module configuration. Use `neva run main` to test your changes locally.