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

Policy for accepting pull requests #8

Open
ltalirz opened this issue Aug 7, 2020 · 6 comments
Open

Policy for accepting pull requests #8

ltalirz opened this issue Aug 7, 2020 · 6 comments
Labels
enhancement New feature or request

Comments

@ltalirz
Copy link
Member

ltalirz commented Aug 7, 2020

Besides passing automatic checks that we set up, for new pull requests, it was suggested that we require

  • computers: the output of verdi computer test <computername>
  • codes: output of ls -l /absolute/path/to/executable

We should create a PR template for this

@ltalirz ltalirz added the enhancement New feature or request label Aug 7, 2020
@ltalirz
Copy link
Member Author

ltalirz commented Oct 5, 2020

Another question is: do we accept only codes compiled by the HPC centre staff or do we also include user-compiled codes (which might be deleted without notice)?

I would say it is ok to accept PRs for user-compiled codes as long as there is some maintenance promise behind, i.e. an intention to inform users of further developments (including an update of this repo).

@yakutovicha
Copy link
Contributor

Just copy-pasting the @sphuber 's question in the PR #22 :

Just a high-level question on the scope of this repository that this PR triggered for me: this addition seems to me to be very specific as it targets an explicit allocation on a single machine, so only people with access to that allocation can use these configurations. I am not sure how many people this would service, but do we have any "limits" on what gets accepted here, or can anyone add any configuration? Could I add a configuration that is just useful for me alone, just to help me simplify configuring my AiiDA install on multiple machines? I am not sure if this has already been discussed and if there is a consensus @ltalirz

@ltalirz
Copy link
Member Author

ltalirz commented Nov 19, 2020

Since the purpose of this registry is to share computer configurations, I think the minimum requirement for accepting new entries should be that they

  • are intended to (or at least can) be used by other AiiDA users as well
  • can be expected to continue working for some time going forward (for how much we can define; e.g. I'd say at least one year)

This in my view excludes codes compiled by specific users unless there is a promise that they will be maintained,
and it excludes temporary scheduler partitions that are going to be deleted.

However, I believe there will always be some gray area, and we cannot expect that all users will be able to use all configurations here out of the box.

The good news is that modifying configurations for your own purposes is very easy - you simply specify the --config ... option together with the options for values you would like to overwrite.

@sphuber
Copy link

sphuber commented Nov 19, 2020

So that would place PR #22 in the gray zone if I understand correctly. I am fine with a gray zone because I don't think there is going to be a way around it, but we should make these guidelines clear in the README.md maybe. Also @yakutovicha the configuration you added, who will be using this?

@ltalirz
Copy link
Member Author

ltalirz commented Nov 19, 2020

I'll create a corresponding PR template then

@yakutovicha
Copy link
Contributor

Also @yakutovicha the configuration you added, who will be using this?

Yes, that is going to be used for the LSMO course. They will use AiiDAlab to perform the isotherm simulations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants