Skip to content

Commit b470db8

Browse files
michmxmichmx
authored
Updating centrally mantained files (#2)
1 parent 265ccbd commit b470db8

5 files changed

Lines changed: 237 additions & 54 deletions

File tree

‎.github/config.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# === IMPORTANT: CENTRALLY MAINTAINED FILE ===
2+
# This file was automatically added via the scripts at the maintenance repository.
3+
# Please do not change it. Rather, update the blueprint in the maintenance repository and propagate
4+
# the changes from there.
5+
# IF YOU REALLY WANT TO MAKE REPOSITORY SPECIFIC CHANGES TO THIS FILE, PLEASE REMOVE THIS NOTICE!
6+
# Tag @klieret for any questions.
7+
# ======
8+
9+
# Configuration for welcome - https://github.com/behaviorbot/welcome
10+
11+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
12+
13+
# Comment to be posted to on first time issues
14+
newIssueWelcomeComment: >
15+
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.
16+
17+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
18+
19+
# Comment to be posted to on PRs from first time contributors in your repository
20+
newPRWelcomeComment: >
21+
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
22+
[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.
23+
24+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
25+
26+
# Comment to be posted to on pull requests merged by a first time user
27+
firstPRMergeComment: >
28+
Congrats on merging your first pull request 🎉! We greatly appreciate it.
29+
30+
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.
31+
If this repository features a list of contributors at the bottom of the readme, you might also be eligible to add yourself there.

‎.github/stale.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# === IMPORTANT: CENTRALLY MAINTAINED FILE ===
2+
# This file was automatically added via the scripts at the maintenance repository.
3+
# Please do not change it. Rather, update the blueprint in the maintenance repository and propagate
4+
# the changes from there.
5+
# IF YOU REALLY WANT TO MAKE REPOSITORY SPECIFIC CHANGES TO THIS FILE, PLEASE REMOVE THIS NOTICE!
6+
# Tag @michmx for any questions.
7+
# ======
8+
9+
# Configuration for probot-stale - https://github.com/probot/stale
10+
11+
# Number of days of inactivity before an Issue or Pull Request becomes stale
12+
daysUntilStale: 60
13+
14+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
15+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
16+
daysUntilClose: false
17+
18+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
19+
onlyLabels: []
20+
21+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
22+
exemptLabels:
23+
- pinned
24+
- security
25+
- "[Status] Maybe Later"
26+
27+
# Set to true to ignore issues in a project (defaults to false)
28+
exemptProjects: false
29+
30+
# Set to true to ignore issues in a milestone (defaults to false)
31+
exemptMilestones: false
32+
33+
# Set to true to ignore issues with an assignee (defaults to false)
34+
exemptAssignees: false
35+
36+
# Label to use when marking as stale
37+
staleLabel: stale
38+
39+
# Comment to post when marking as stale. Set to `false` to disable
40+
markComment: >
41+
This issue or pull request has been automatically marked as stale because it has not had
42+
recent activity. Please manually close it, if it is no longer relevant,
43+
or ask for help or support to help getting it unstuck.
44+
Let me bring this to the attention of @amorenobr @vlukashenko @richa2710 @michmx for now.
45+
46+
# Comment to post when removing the stale label.
47+
# unmarkComment: >
48+
# Your comment here.
49+
50+
# Comment to post when closing a stale Issue or Pull Request.
51+
# closeComment: >
52+
# Your comment here.
53+
54+
# Limit the number of actions per hour, from 1-30. Default is 30
55+
limitPerRun: 30
56+
# Limit to only `issues` or `pulls`
57+
# only: issues
58+
59+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
60+
# pulls:
61+
# daysUntilStale: 30
62+
# markComment: >
63+
# This pull request has been automatically marked as stale because it has not had
64+
# recent activity. It will be closed if no further activity occurs. Thank you
65+
# for your contributions.
66+
67+
# issues:
68+
# exemptLabels:
69+
# - confirmed

‎.pre-commit-config.yaml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# === IMPORTANT: CENTRALLY MAINTAINED FILE ===
2+
# This file was automatically added via the scripts at the maintenance repository.
3+
# Please do not change it. Rather, update the blueprint in the maintenance repository and propagate
4+
# the changes from there.
5+
# IF YOU REALLY WANT TO MAKE REPOSITORY SPECIFIC CHANGES TO THIS FILE, PLEASE REMOVE THIS NOTICE!
6+
# Tag @klieret for any questions.
7+
# ======
8+
9+
ci:
10+
autoupdate_schedule: monthly
11+
12+
repos:
13+
- repo: https://github.com/pre-commit/pre-commit-hooks
14+
rev: v5.0.0
15+
hooks:
16+
- id: check-added-large-files
17+
- id: check-case-conflict
18+
- id: check-merge-conflict
19+
- id: check-symlinks
20+
- id: debug-statements
21+
- id: end-of-file-fixer
22+
files: ^(_episodes|README.md|setup.md)
23+
- id: mixed-line-ending
24+
- id: trailing-whitespace
25+
files: ^(_episodes|code|README.md|setup.md)
26+
27+
- repo: https://github.com/codespell-project/codespell
28+
rev: "v2.4.1"
29+
hooks:
30+
- id: codespell
31+
args: ["-I", "codespell.txt"]
32+
files: '.*\.md'

‎CONTRIBUTING.md‎

Lines changed: 104 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,106 @@
11
# Contributing
22

3-
Contributions are welcome, and they are greatly appreciated! Every little bit
4-
helps, and credit will always be given. You can contribute in the ways listed below.
5-
6-
## Report Bugs
7-
8-
Report bugs using GitHub issues.
9-
10-
If you are reporting a bug, please include:
11-
12-
* Your operating system name and version.
13-
* Any details about your local setup that might be helpful in troubleshooting.
14-
* Detailed steps to reproduce the bug.
15-
16-
## Fix Bugs
17-
18-
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
19-
wanted" is open to whoever wants to implement it.
20-
21-
## Implement Features
22-
23-
Look through the GitHub issues for features. Anything tagged with "enhancement"
24-
and "help wanted" is open to whoever wants to implement it.
25-
26-
## Write Documentation
27-
28-
Array-oriented programming for data analysis could always use more documentation, whether as part of the
29-
official Array-oriented programming for data analysis docs, in docstrings, or even on the web in blog posts,
30-
articles, and such.
31-
32-
## Submit Feedback
33-
34-
The best way to send feedback is to file an issue on GitHub.
35-
36-
If you are proposing a feature:
37-
38-
* Explain in detail how it would work.
39-
* Keep the scope as narrow as possible, to make it easier to implement.
40-
* Remember that this is a volunteer-driven project, and that contributions
41-
are welcome :)
42-
43-
## Get Started
44-
45-
Ready to contribute? Here's how to set up `Array-oriented programming for data analysis` for local development.
46-
47-
1. Fork the repo on GitHub.
48-
2. Clone your fork locally.
49-
3. Install your local copy into a virtualenv, e.g., using `conda`.
50-
4. Create a branch for local development and make changes locally.
51-
5. Commit your changes and push your branch to GitHub.
52-
6. Submit a pull request through the GitHub website.
53-
54-
## Code of Conduct
55-
56-
Please note that the Array-oriented programming for data analysis project is released with a [Contributor Code of Conduct](CONDUCT.md). By contributing to this project you agree to abide by its terms.
3+
[HSF training][hsf-training] is an open source project,
4+
and we welcome contributions of all kinds:
5+
new lessons,
6+
fixes to existing material,
7+
bug reports,
8+
and reviews of proposed changes are all welcome.
9+
10+
## Contributor Agreement
11+
12+
By contributing,
13+
you agree that we may redistribute your work under [our license](LICENSE.md).
14+
In exchange,
15+
we will address your issues and/or assess your change proposal as promptly as we can,
16+
and help you become a member of our community.
17+
Everyone involved in [HSF training][hsf-training]
18+
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
19+
20+
## How to Contribute
21+
22+
The easiest way to get started is to file an issue
23+
to tell us about a mistake,
24+
some awkward wording,
25+
or a factual error.
26+
This is a good way to introduce yourself
27+
and to meet some of our community members.
28+
29+
1. If you do not have a [GitHub][github] account,
30+
you can write the convenors an email.
31+
However,
32+
we will be able to respond more quickly if you use one of the other methods described below.
33+
34+
2. If you have a [GitHub][github] account,
35+
or are willing to [create one][github-join],
36+
but do not know how to use Git,
37+
you can report problems or suggest improvements by [creating an issue][issues].
38+
This allows us to assign the item to someone
39+
and to respond to it in a threaded discussion.
40+
41+
3. If you are comfortable with Git,
42+
and would like to add or change material,
43+
you can submit a pull request (PR).
44+
Instructions for doing this are [included below](#using-github).
45+
46+
## What to Contribute
47+
48+
There are many ways to contribute,
49+
from writing new exercises and improving existing ones
50+
to updating or filling in the documentation
51+
and submitting [bug reports][issues]
52+
about things that do not work, are not clear, or are missing.
53+
If you are looking for ideas, please see the 'Issues' tab for
54+
a list of issues associated with this repository,
55+
or you may also look at all issues in [hsf-training][hsf-training-issues]
56+
57+
There is also [a list](hsf-training-gfis) of all issues that are particularly easy and suitable
58+
for first contributions.
59+
60+
Comments on issues and reviews of pull requests are just as welcome:
61+
we are smarter together than we are on our own.
62+
Reviews from novices and newcomers are particularly valuable:
63+
it is easy for people who have been using these lessons for a while
64+
to forget how impenetrable some of this material can be,
65+
so fresh eyes are always welcome.
66+
67+
## Using GitHub
68+
69+
If you choose to contribute via GitHub, you may want to look at
70+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
71+
To manage changes, we follow [GitHub flow][github-flow].
72+
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
73+
The maintainers are community volunteers and have final say over what gets merged into the lesson.
74+
To use the web interface for contributing to a lesson:
75+
76+
1. Fork the originating repository to your GitHub profile.
77+
2. Within your version of the forked repository, move to the `gh-pages` branch and
78+
create a new branch for each significant change being made.
79+
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
80+
4. Commit all changed files within the appropriate branches.
81+
5. Create individual pull requests from each of your changed branches
82+
to the `gh-pages` branch within the originating repository.
83+
6. If you receive feedback, make changes using your issue-specific branches of the forked
84+
repository and the pull requests will update automatically.
85+
7. Repeat as needed until all feedback has been addressed.
86+
87+
When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
88+
before creating your own revision-specific branch(es) from there.
89+
Additionally, please only work from your newly-created branch(es) and *not*
90+
your clone of the originating `gh-pages` branch.
91+
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
92+
repository for reference while revising.
93+
94+
## Other Resources
95+
96+
More information on how to contribute or how to contact us: [HSF training home][hsf-training]
97+
98+
[hsf-training-issues]: https://github.com/issues?q=user%3Ahsf-training+is%3Aopen
99+
[hsf-training]: https://hepsoftwarefoundation.org/workinggroups/training.html
100+
[email]: mailto:https://groups.google.com/forum/#!forum/hsf-training-wg
101+
[github]: https://github.com
102+
[github-flow]: https://guides.github.com/introduction/flow/
103+
[github-join]: https://github.com/join
104+
[how-contribute]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
105+
[issues]: https://guides.github.com/features/issues/
106+
[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

‎codespell.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
hist

0 commit comments

Comments
 (0)