Skip to content

Move scope/contributing guidelines to README #422

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

Closed
dstansby wants to merge 1 commit into from
Closed

Move scope/contributing guidelines to README #422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 0 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
This template and our [recommendation pages][website] were made by [research
software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC].
We made it with research software projects in mind, but whoever you are, we hope
you find this useful!

We are actively encouraging users to ask questions and start discussions in the
[discussions tab] of this repository. Does something seem like it's broken?
Please go ahead and [open an issue]!

The [website] pages are open to contributions but they will need to be reviewed
by a member or associate member of ARC. We might be slow to approve new tool
suggestions (since we'll probably want to discuss them first) but don't let that
put you off creating an issue.

## Development workflow

To contribute a change, please:
Expand All @@ -30,10 +16,5 @@ To contribute a change, please:
<!-- links here -->

<!-- prettier-ignore-start -->
[website]: https://github-pages.arc.ucl.ac.uk/python-tooling
[UCL ARC]: https://ucl.ac.uk/arc
[open an issue]: https://github.com/UCL-ARC/python-tooling/issues/new/choose
[Discussions tab]: https://github.com/UCL-ARC/python-tooling/discussions
[Research software engineers]: https://society-rse.org/about/history
[@UCL-ARC/collaborations]: https://github.com/orgs/UCL-ARC/teams/collaborations
<!-- prettier-ignore-end -->
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,26 @@ Python packages with our recommended tooling set up and ready to go.
> package template (e.g., [`scikit-hep`](https://github.com/scikit-hep/cookie)),
> we recommend using their template instead of this one.

## Scope and contributing

This project was created by [research software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC].
We made it with our own research software projects in mind - we don't explicitly support external users, but whoever you are, we hope you might find it useful!
Copy link
Member

@samcunliffe samcunliffe Jun 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also don't really like "we don't explicitly support external users".

I'm biased to how I had it, but I did spend effort thinking carefully about how it was worded.

Copy link
Member

@paddyroddy paddyroddy Jun 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the current one. Whatever happens this should be the "groups" view, not one individuals.


This repository is open to contributions from all, but they will need be reviewed by a member or associate member of ARC.
We might be slow to approve new tool suggestions (since we'll probably want to discuss them first) but don't let that put you off creating an issue or opening a pull request.
See [CONTRIBUTING.md] for more details on how to contribute.

We also accept (and encourage!) suggestions and bug reports from anyone.
Use the [discussions tab] of this repository to ask questions or [open an issue] if something seems like it's broken.
Copy link
Member

@samcunliffe samcunliffe Jun 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto with how I worded previously...

We are actively encouraging users to ask questions and start discussions in the
[discussions tab] of this repository. Does something seem like it's broken?
Please go ahead and [open an issue]!


<!-- links here -->

<!-- prettier-ignore-start -->
[website]: https://github-pages.arc.ucl.ac.uk/python-tooling
[UCL ARC]: https://ucl.ac.uk/arc
[cookiecutter]: https://libraries.io/pypi/cookiecutter
[open an issue]: https://github.com/UCL-ARC/python-tooling/issues/new/choose
[discussions tab]: https://github.com/UCL-ARC/python-tooling/discussions
<!-- prettier-ignore-end -->

## Contributors
Expand Down