Skip to content

Commit

Permalink
Update common files (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
@klieret
klieret authored Jan 9, 2023
1 parent 6bc3914 commit b43f21c
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 87 deletions.
20 changes: 5 additions & 15 deletions .github/config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,20 @@

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Thanks for opening your first issue here 💖! If you have any questions, feel free
to mention one of the conveners, previous contributors, or attend our weekly meeting (see
https://hepsoftwarefoundation.org/workinggroups/training.html).
Also, sometimes issues go unnoticed, so don't hesitate to @mention some of
us, if we do not come back to you within a few days.
Thanks for opening your first issue here 💖! If you have any questions, feel free to mention one of the conveners, previous contributors, or attend our weekly meeting (see https://hepsoftwarefoundation.org/workinggroups/training.html). Also, sometimes issues go unnoticed, so don't hesitate to @mention some of us, if we do not come back to you within a few days.
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Thanks for opening your first pull request here 🚀! If you have any questions, feel free
to mention one of the conveners, previous contributors, or attend our weekly meeting (see
[our homepage](https://hepsoftwarefoundation.org/workinggroups/training.html)).
Also, sometimes PRs go unnoticed, so don't hesitate to @mention some of
us, if we do not come back to you within a few days.
Thanks for opening your first pull request here 🚀! If you have any questions, feel free to mention one of the conveners, previous contributors, or attend our weekly meeting (see
[our homepage](https://hepsoftwarefoundation.org/workinggroups/training.html)). Also, sometimes PRs go unnoticed, so don't hesitate to @mention some of us, if we do not come back to you within a few days.
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
Congrats on merging your first pull request 🎉! We greatly appreciate it.
You might be eligible to be added to the
[HSF Training Community](https://hepsoftwarefoundation.org/training/https://hepsoftwarefoundation.org/training/community_by_year) page
(see the instructions on the page for how to create a profile). If you already have created a profile previously, make sure you're also added to the current year.
If this repository features a list of contributors at the bottom of the readme, you are also eligible to add yourself there.
You might be eligible to be added to the [HSF Training Community](https://hepsoftwarefoundation.org/training/community_by_year) page (see the instructions on the page for how to create a profile). If you already have created a profile previously, make sure you're also added to the current year.
If this repository features a list of contributors at the bottom of the readme, you might also be eligible to add yourself there.
2 changes: 1 addition & 1 deletion .github/stale.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ limitPerRun: 30

# issues:
# exemptLabels:
# - confirmed
# - confirmed
3 changes: 1 addition & 2 deletions .pre-commit-config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,11 @@ repos:
- id: codespell
args: ["-I", "codespell.txt"]
files: '.*\.md'

# === END CENTRALLY MAINTAINED FILE ===

- repo: https://github.com/asottile/blacken-docs
rev: v1.12.1
hooks:
- id: blacken-docs
additional_dependencies: [black==22.6.0]
files: '.*\.md'
files: '.*\.md'
96 changes: 27 additions & 69 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
[HSF training][hsf-training] is an open source project,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
Expand All @@ -14,91 +14,56 @@ you agree that we may redistribute your work under [our license](LICENSE.md).
In exchange,
we will address your issues and/or assess your change proposal as promptly as we can,
and help you become a member of our community.
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
Everyone involved in [HSF training][hsf-training]
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).

## How to Contribute

The easiest way to get started is to file an issue
to tell us about a spelling mistake,
to tell us about a mistake,
some awkward wording,
or a factual error.
a factual error.
This is a good way to introduce yourself
and to meet some of our community members.

1. If you do not have a [GitHub][github] account,
you can [send us comments by email][email].
1. If you do not have a [GitHub][github] account,
you can write the convenors an email.
However,
we will be able to respond more quickly if you use one of the other methods described below.

2. If you have a [GitHub][github] account,
2. If you have a [GitHub][github] account,
or are willing to [create one][github-join],
but do not know how to use Git,
you can report problems or suggest improvements by [creating an issue][issues].
This allows us to assign the item to someone
and to respond to it in a threaded discussion.

3. If you are comfortable with Git,
3. If you are comfortable with Git,
and would like to add or change material,
you can submit a pull request (PR).
Instructions for doing this are [included below](#using-github).

## Where to Contribute

1. If you wish to change this lesson,
please work in <https://github.com/masonproffitt/uproot-tutorial>,
which can be viewed at <https://masonproffitt.github.io/uproot-tutorial>.

2. If you wish to change the example lesson,
please work in <https://github.com/carpentries/lesson-example>,
which documents the format of our lessons
and can be viewed at <https://carpentries.github.io/lesson-example>.

3. If you wish to change the template used for workshop websites,
please work in <https://github.com/carpentries/workshop-template>.
The home page of that repository explains how to set up workshop websites,
while the extra pages in <https://carpentries.github.io/workshop-template>
provide more background on our design choices.

4. If you wish to change CSS style files, tools,
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
please work in <https://github.com/carpentries/styles>.

## What to Contribute

There are many ways to contribute,
from writing new exercises and improving existing ones
to updating or filling in the documentation
and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing.
about things that do not work, aren not clear, or are missing.
If you are looking for ideas, please see the 'Issues' tab for
a list of issues associated with this repository,
or you may also look at the issues for [Data Carpentry][dc-issues]
and [Software Carpentry][swc-issues] projects.
or you may also look at all issues in [hsf-training][hsf-training-issues]

There is also [a list](hsf-training-gfis) of all issues that are particularly easy and suitable
for first contributions.

Comments on issues and reviews of pull requests are just as welcome:
we are smarter together than we are on our own.
Reviews from novices and newcomers are particularly valuable:
it's easy for people who have been using these lessons for a while
it is easy for people who have been using these lessons for a while
to forget how impenetrable some of this material can be,
so fresh eyes are always welcome.

## What *Not* to Contribute

Our lessons already contain more material than we can cover in a typical workshop,
so we are usually *not* looking for more concepts or tools to add to them.
As a rule,
if you want to introduce a new idea,
you must (a) estimate how long it will take to teach
and (b) explain what you would take out to make room for it.
The first encourages contributors to be honest about requirements;
the second, to think hard about priorities.

We are also not looking for exercises or other material that only run on one platform.
Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
in order to be usable,
our lessons must run equally well on all three.

## Using GitHub

If you choose to contribute via GitHub, you may want to look at
Expand All @@ -108,16 +73,16 @@ Each lesson has two maintainers who review issues and pull requests or encourage
The maintainers are community volunteers and have final say over what gets merged into the lesson.
To use the web interface for contributing to a lesson:

1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch and
1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch and
create a new branch for each significant change being made.
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches
to the `gh-pages` branch within the originating repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked
6. If you receive feedback, make changes using your issue-specific branches of the forked
repository and the pull requests will update automatically.
7. Repeat as needed until all feedback has been addressed.
7. Repeat as needed until all feedback has been addressed.

When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
before creating your own revision-specific branch(es) from there.
Expand All @@ -128,21 +93,14 @@ repository for reference while revising.

## Other Resources

General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
happens on the [discussion mailing list][discuss-list],
which everyone is welcome to join.
You can also [reach us by email][email].
More information on how to contribute or how to contact us: [HSF training home][hsf-training]

[email]: mailto:[email protected]
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[dc-lessons]: http://datacarpentry.org/lessons/
[dc-site]: http://datacarpentry.org/
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
[hsf-training-issues]: https://github.com/issues?q=user%3Ahsf-training+is%3Aopen
[hsf-training]: https://hepsoftwarefoundation.org/workinggroups/training.html
[email]: mailto:https://groups.google.com/forum/#!forum/hsf-training-wg
[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[how-contribute]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
[issues]: https://guides.github.com/features/issues/
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: https://software-carpentry.org/lessons/
[swc-site]: https://software-carpentry.org/
[hsf-training-gfis]: https://github.com/issues?q=is%3Aissue+is%3Aopen+archived%3Afalse+sort%3Aupdated-desc+label%3A%22good+first+issue%22+org%3Ahsf-training

0 comments on commit b43f21c

Please sign in to comment.