Skip to content
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.

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

Introduce a CONTRIBUTING.md to guide potential contributors #317

Open
scroix opened this issue Apr 19, 2024 · 0 comments
Open

Introduce a CONTRIBUTING.md to guide potential contributors #317

scroix opened this issue Apr 19, 2024 · 0 comments

Comments

@scroix
Copy link
Member

scroix commented Apr 19, 2024

Nodel currently lacks any guidance on contribution. I propose adding one to guide potential contributors and streamline the contribution process.

The document should include:

  • Brief technical introduction to Nodel
  • Setup instructions for the development environment
  • Contribution guidelines (coding conventions, commit messages, PRs)
  • Issue reporting instructions

There are some really blue sky examples from large organisations:

But even some good examples from smaller projects:

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

No branches or pull requests

1 participant