search

dwavesystems / demos

WARNING: This repo is obsolete. For D-Wave Ocean code examples, go to the `dwave-examples` GitHub account.
https://github.com/dwave-examples
Apache License 2.0
39 stars 37 forks source link

Feature/contribution info #96

Closed m3ller closed 5 years ago

m3ller commented 5 years ago

Add contributing.rst, which shows up when someone is making a Pull Request or writes up an issue.

m3ller commented 5 years ago

I had the file in .github because it isn't anything that outside developers should change or interact with. I just needed the file to show up when PRs are made.

With that said, if the standard is to leave it in root, then I shall do that instead. (thinking about it some more, it's nice for outside devs to see that we have a contributing file at first glance)

arcondello commented 5 years ago

I think once there are multiple "special" files it makes sense to start nesting them rather than putting them all in the top level. E.g. in this case we also have CODEOWNERS and ISSUE_TEMPLATE.

JoelPasvolsky commented 5 years ago

I was asking because in other repos like dimod such files with information for contributors--contributing, license--is in the root folder. Would be good to be consistent across our repos.

arcondello commented 5 years ago

Fair enough - I think it's slightly tidier to start nesting them once there are 3+ but it's definitely a weak preference.

I do think LICENSE is special and should be in the top level.

m3ller commented 5 years ago

I think for consistency, I will just leave the CONTRIBUTING.rst out in the root dir. We can nest all the special files across all the repos at once (at a later time, should we decide to do so).

randomir commented 5 years ago

FWIW, the "standard" I've observed in the wild is to have many of them in project root. I don't quite like that, but for many files it makes sense.

For github-specific files like CODEOWNERS and issue templates, we should keep them under .github, though.

CI files would all ideally be under .ci/.circleci (or similar).

Readme, license, authors, and change log all go at the root level.

We could probably get rid of "contributing" file (and keep those few lines in readme), but it's a custom to have it. As well as "code of conduct" these days.

JoelPasvolsky commented 5 years ago

That is an interesting point, I wonder whether for OS repos that we want public contributions it's expected that we display the D-Wave code of conduct.

randomir commented 5 years ago

Well, GitHub recommends following https://opensource.guide/, and having:

So, at some point in future we might want to address those recommendations.