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

Add CONTRIBUTING.md #17

Open
KristijanArmeni opened this issue Nov 22, 2024 · 1 comment
Open

Add CONTRIBUTING.md #17

KristijanArmeni opened this issue Nov 22, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@KristijanArmeni
Copy link
Collaborator

We should add some basic guidelines on how to contribute a new test. The goal is to make it easier for new users to contribute their test and what is expected.

For now that can be a "How to contribute" section in the README.md or a standalone CONTRIBUTING.md file. Minimally, it should provide the following:

  • where to put the code for a test
  • what files must be in the folder (e.g. interface.py, main.py)
  • what each of the files mean and what contents (functions, docs etc.) should the new contributor put there
  • How to contribute once the test is written (via a pull request)

In general, the Participation guidelines section of The Turing Way book gives a nice overview of how good practices look like.

@KristijanArmeni KristijanArmeni added the documentation Improvements or additions to documentation label Nov 22, 2024
@soul-codes
Copy link
Collaborator

@KristijanArmeni I was thinking a bit about this. Ideally, we want the best of both worlds:

  1. The entry barrier for new contribution should be low, even if the analyzer contributed is only in PoC stage.
  2. The level of maturity for each analyzer offered should be clear to end-users. For example, if something cannot cope with large datasets, or is excruciatingly slow, or is not yet thoroughly tested, it should perhaps have a different indicator.

Especially in our kind of community with dynamic participation and commitment, success of (1) necessitates (2).

A CONTRIBUTING.md file can help make (1) happen, and some kind of reviewing/maturity marking indicator should probably be put in place to to achieve (2).

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

No branches or pull requests

2 participants