Skip to content

Commit 89f353a

Browse files
committed
Tidy everything
1 parent 9b02849 commit 89f353a

File tree

16 files changed

+275
-333
lines changed

16 files changed

+275
-333
lines changed

.github/CONTRIBUTING.md

Lines changed: 65 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -6,59 +6,66 @@ We are always after more contributors and suggestions.
66

77
#### Does it relate to our API (backend)... ?
88

9-
1. Please check the [previously reported API issues](https://github.com/CPAN-API/cpan-api/issues)
10-
2. Please check the [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist). If you can't find it already there:
11-
* If it's a wishlist idea, please edit the [wiki](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) (add a 'wishlist_MYIDEA' page if you need more space!)
12-
* If it's an actual bug [create a new issue](https://github.com/CPAN-API/cpan-api/issues/new)
9+
1. Please check the [previously reported API issues](https://github.com/CPAN-API/cpan-api/issues)
10+
2. Please check the [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist). If you can't
11+
find it already there:
12+
- If it's a wishlist idea, please edit the
13+
[wiki](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) (add a 'wishlist_MYIDEA' page if
14+
you need more space!)
15+
- If it's an actual bug [create a new issue](https://github.com/CPAN-API/cpan-api/issues/new)
1316

1417
#### If you are not sure, or it is related to https://metacpan.org/ front end:
1518

16-
1. Please check the [previously reported Web issues](https://github.com/CPAN-API/metacpan-web/issues)
17-
2. Please check the [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist). If you can't find it already there:
18-
* If it's a wishlist idea, please edit the [wiki](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) (add a 'wishlist_MYIDEA' page if you need more space!)
19-
* If it's an actual bug [create a new issue](https://github.com/CPAN-API/metacpan-web/issues/new)
19+
1. Please check the
20+
[previously reported Web issues](https://github.com/CPAN-API/metacpan-web/issues)
21+
2. Please check the [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist). If you can't
22+
find it already there:
23+
- If it's a wishlist idea, please edit the
24+
[wiki](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) (add a 'wishlist_MYIDEA' page if
25+
you need more space!)
26+
- If it's an actual bug
27+
[create a new issue](https://github.com/CPAN-API/metacpan-web/issues/new)
2028

2129
## Contributing code
2230

23-
Come talk to us on IRC (see below), or send a pull request and we'll respond
24-
there. If you implement a new feature, please add a note about it to the
25-
News.md file at the top level of metacpan-web so that it will appear in our
26-
news feed.
31+
Come talk to us on IRC (see below), or send a pull request and we'll respond there. If you implement
32+
a new feature, please add a note about it to the News.md file at the top level of metacpan-web so
33+
that it will appear in our news feed.
2734

2835
If you aren't using the VM, remember to enable the pre-commit hook before you start working.
2936

3037
sh git/setup.sh
3138

3239
These links will get you going quickly:
3340

34-
* [Using our developer VM](https://github.com/CPAN-API/metacpan-developer) to get you going in minutes (depending on bandwidth)
35-
* [Front end bug list](https://github.com/CPAN-API/metacpan-web/issues)
36-
* [API (back end) bug list](https://github.com/CPAN-API/cpan-api/issues)
37-
* [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) - things that probably need doing
41+
- [Using our developer VM](https://github.com/CPAN-API/metacpan-developer) to get you going in
42+
minutes (depending on bandwidth)
43+
- [Front end bug list](https://github.com/CPAN-API/metacpan-web/issues)
44+
- [API (back end) bug list](https://github.com/CPAN-API/cpan-api/issues)
45+
- [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) - things that probably need doing
3846

3947
# Git workflow
4048

41-
We try to keep a clean git history, so if it all possible, please rebase to get
42-
the latest changes from master _before_ submitting a pull request. You'll only
43-
need to do the first command (git remote add) once in your local checkout.
49+
We try to keep a clean git history, so if it all possible, please rebase to get the latest changes
50+
from master _before_ submitting a pull request. You'll only need to do the first command (git remote
51+
add) once in your local checkout.
4452

4553
git remote add upstream https://github.com/CPAN-API/metacpan-web.git
4654
git pull --rebase upstream master
4755

48-
If you are comfortable rebasing, it is also helpful to squash or delete commits
49-
which are no longer relevant to your branch before submitting your work.
56+
If you are comfortable rebasing, it is also helpful to squash or delete commits which are no longer
57+
relevant to your branch before submitting your work.
5058

5159
git rebase -i master
5260

53-
If you are not comfortable with rebasing, but want to use it, check out the steps
54-
from [here](https://help.github.com/articles/using-git-rebase/).
61+
If you are not comfortable with rebasing, but want to use it, check out the steps from
62+
[here](https://help.github.com/articles/using-git-rebase/).
5563

5664
# Coding conventions
5765

58-
Please try to follow the conventions already been used in the code base. This
59-
will generally be the right thing to do. Our standards are improving, so even
60-
if you do follow what you see, we may ask you to make some changes, but that is
61-
a good thing. We are trying to keep things tidy.
66+
Please try to follow the conventions already been used in the code base. This will generally be the
67+
right thing to do. Our standards are improving, so even if you do follow what you see, we may ask
68+
you to make some changes, but that is a good thing. We are trying to keep things tidy.
6269

6370
If you are using the [developer VM](https://github.com/CPAN-API/metacpan-developer) you can run:
6471

@@ -68,72 +75,69 @@ If you are using the [developer VM](https://github.com/CPAN-API/metacpan-develop
6875

6976
## Perl Best Practices
7077

71-
In general, the concepts discussed in "Perl Best Practices" are a good starting
72-
point. Use autodie where possible and MetaCPAN::Web::Types when creating new
73-
Moose attributes. Many of the other standards will be enforced by Perl::Critic.
78+
In general, the concepts discussed in "Perl Best Practices" are a good starting point. Use autodie
79+
where possible and MetaCPAN::Web::Types when creating new Moose attributes. Many of the other
80+
standards will be enforced by Perl::Critic.
7481

7582
## Clear > Concise
7683

77-
Take pains to use variable names which are easy to understand and to write
78-
readable code. We value readable code over concise code. Use singular nouns
79-
for class names. Use verbs for method names.
84+
Take pains to use variable names which are easy to understand and to write readable code. We value
85+
readable code over concise code. Use singular nouns for class names. Use verbs for method names.
8086

8187
## Try::Tiny > eval { ... }
8288

83-
You will see many eval statements in the code. We would like to standardize on
84-
Try::Tiny, so feel free to swap out any eval with a Try::Tiny and use Try::Tiny
85-
in all new code.
89+
You will see many eval statements in the code. We would like to standardize on Try::Tiny, so feel
90+
free to swap out any eval with a Try::Tiny and use Try::Tiny in all new code.
8691

8792
## Prefer single quotes
8893

89-
Always use single quotes in cases where there is no variable interpolation. If
90-
there is a single quote in the quoted item, use curly quotes.
94+
Always use single quotes in cases where there is no variable interpolation. If there is a single
95+
quote in the quoted item, use curly quotes.
9196

9297
q{Isn't this a lovely day};
9398

9499
## Include a test (or more!)
95100

96-
Any time when a pull request includes a test, it makes it easier for us to
97-
review and accept, so please do test your changes whenever possible. If your
98-
pull request includes visual changes, please include a before and after screen
99-
shot, so that we can better understand the problem you're trying to solve.
101+
Any time when a pull request includes a test, it makes it easier for us to review and accept, so
102+
please do test your changes whenever possible. If your pull request includes visual changes, please
103+
include a before and after screen shot, so that we can better understand the problem you're trying
104+
to solve.
100105

101106
## Dependencies
102107

103-
Introducing new dependencies is fine, if they solve a specific problem which
104-
current dependencies cannot address. If we prefer a different module to be used,
105-
we'll let you know.
108+
Introducing new dependencies is fine, if they solve a specific problem which current dependencies
109+
cannot address. If we prefer a different module to be used, we'll let you know.
106110

107111
## It's OK to be controversial
108112

109-
If a pull request contains any controversial changes, we'll likely wait for some
110-
feedback from several developers before a merge. If you think your changes may
111-
be controversial, feel free to discuss them in a GitHub issue before starting to
112-
write any code.
113+
If a pull request contains any controversial changes, we'll likely wait for some feedback from
114+
several developers before a merge. If you think your changes may be controversial, feel free to
115+
discuss them in a GitHub issue before starting to write any code.
113116

114117
## Travis is your friend
115118

116-
We use Travis to test all code changes. After submitting your pull request,
117-
remember to check back to see whether Travis has come back with any test
118-
failures. We do get some false negatives. If your pull request failed for
119-
reasons unrelated to your changes, we may still be able to merge your work.
119+
We use Travis to test all code changes. After submitting your pull request, remember to check back
120+
to see whether Travis has come back with any test failures. We do get some false negatives. If your
121+
pull request failed for reasons unrelated to your changes, we may still be able to merge your work.
120122

121123
# Additional Resources
122124

123-
* [\#metacpan](http://widget01.mibbit.com/?autoConnect=true&server=irc.perl.org&channel=%23metacpan&nick=) IRC channel on irc.perl.org
125+
- [\#metacpan](http://widget01.mibbit.com/?autoConnect=true&server=irc.perl.org&channel=%23metacpan&nick=)
126+
IRC channel on irc.perl.org
124127

125128
# Current Policies
126129

127130
### What is indexed?
128131

129-
* Perl distributions which contain Perl packages.
132+
- Perl distributions which contain Perl packages.
130133

131134
### When are issues closed?
132135

133-
We want to keep the issue list manageable, so we can focus on what actually
134-
needs fixing. If you feel an issue needs opening again, please add a comment
135-
explaining why it needs re-opening and we'll look at it again.
136+
We want to keep the issue list manageable, so we can focus on what actually needs fixing. If you
137+
feel an issue needs opening again, please add a comment explaining why it needs re-opening and we'll
138+
look at it again.
136139

137-
* Issues will be closed and moved to [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist) if they are not actual bugs
138-
* Issues we think we have addressed will be closed
139-
* Issues we are not going to take any further action on without more information will be closed
140+
- Issues will be closed and moved to [Wishlist](https://github.com/CPAN-API/cpan-api/wiki/Wishlist)
141+
if they are not actual bugs
142+
- Issues we think we have addressed will be closed
143+
- Issues we are not going to take any further action on without more information will be closed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
4+
title: ""
55
labels: ["type:Bug"]
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**PLEASE NOTE**
1110

12-
This issue tracker is for bugs in the https://metacpan.org web site. If you are are reporting a bug about anything else, this is most likely not the correct venue. Please use the left side menu for the module you are interested in and click the `Issues` link in order to find the bug tracker for your module.
11+
This issue tracker is for bugs in the https://metacpan.org web site. If you are are reporting a bug
12+
about anything else, this is most likely not the correct venue. Please use the left side menu for
13+
the module you are interested in and click the `Issues` link in order to find the bug tracker for
14+
your module.
15+
16+
**Describe the bug** A clear and concise description of what the bug is.
1317

14-
**Describe the bug**
15-
A clear and concise description of what the bug is.
18+
**To Reproduce** Steps to reproduce the behavior:
1619

17-
**To Reproduce**
18-
Steps to reproduce the behavior:
1920
1. Go to '...'
2021
2. Click on '....'
2122
3. Scroll down to '....'
2223
4. See error
2324

24-
**Expected behavior**
25-
A clear and concise description of what you expected to happen.
25+
**Expected behavior** A clear and concise description of what you expected to happen.
2626

27-
**Screenshots**
28-
If applicable, add screenshots to help explain your problem.
27+
**Screenshots** If applicable, add screenshots to help explain your problem.
2928

3029
**Desktop (please complete the following information):**
31-
- OS: [e.g. iOS]
32-
- Browser [e.g. chrome, safari]
33-
- Version [e.g. 22]
30+
31+
- OS: [e.g. iOS]
32+
- Browser [e.g. chrome, safari]
33+
- Version [e.g. 22]
3434

3535
**Smartphone (please complete the following information):**
36-
- Device: [e.g. iPhone6]
37-
- OS: [e.g. iOS8.1]
38-
- Browser [e.g. stock browser, safari]
39-
- Version [e.g. 22]
4036

41-
**Additional context**
42-
Add any other context about the problem here.
37+
- Device: [e.g. iPhone6]
38+
- OS: [e.g. iOS8.1]
39+
- Browser [e.g. stock browser, safari]
40+
- Version [e.g. 22]
41+
42+
**Additional context** Add any other context about the problem here.
Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
---
22
name: Feature request
33
about: Request a feature to be added
4-
title: ''
4+
title: ""
55
labels: ["type:Feature"]
6-
assignees: ''
7-
6+
assignees: ""
87
---
9-
**Describe the feature**
10-
A clear and concise description of what the feature is.
8+
9+
**Describe the feature** A clear and concise description of what the feature is.
1110

1211
**Which problem does it solve?**
1312

14-
**Expected behavior**
15-
A clear and concise description of what you expect to see.
13+
**Expected behavior** A clear and concise description of what you expect to see.
1614

17-
**Volunteering**
18-
Are you willing to implement (or help to implement) this feature?
15+
**Volunteering** Are you willing to implement (or help to implement) this feature?
1916

20-
**Additional context**
21-
Add any other context about the request here.
17+
**Additional context** Add any other context about the request here.

.github/workflows/codeql-analysis.yml

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Code scanning - action"
1+
name: 'Code scanning - action'
22

33
on:
44
push:
@@ -10,39 +10,38 @@ on:
1010

1111
jobs:
1212
CodeQL-Build:
13-
1413
runs-on: ubuntu-22.04
1514

1615
steps:
17-
- name: Checkout repository
18-
uses: actions/checkout@v4
19-
with:
20-
# We must fetch at least the immediate parents so that if this is
21-
# a pull request then we can checkout the head.
22-
fetch-depth: 2
23-
24-
# Initializes the CodeQL tools for scanning.
25-
- name: Initialize CodeQL
26-
uses: github/codeql-action/init@v3
27-
# Override language selection by uncommenting this and choosing your languages
28-
# with:
29-
# languages: go, javascript, csharp, python, cpp, java
30-
31-
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
32-
# If this step fails, then you should remove it and run the build manually (see below)
33-
- name: Autobuild
34-
uses: github/codeql-action/autobuild@v3
35-
36-
# ℹ️ Command-line programs to run using the OS shell.
37-
# 📚 https://git.io/JvXDl
38-
39-
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
40-
# and modify them (or add more) to build your code if your project
41-
# uses a compiled language
42-
43-
#- run: |
44-
# make bootstrap
45-
# make release
46-
47-
- name: Perform CodeQL Analysis
48-
uses: github/codeql-action/analyze@v3
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
with:
19+
# We must fetch at least the immediate parents so that if this is
20+
# a pull request then we can checkout the head.
21+
fetch-depth: 2
22+
23+
# Initializes the CodeQL tools for scanning.
24+
- name: Initialize CodeQL
25+
uses: github/codeql-action/init@v3
26+
# Override language selection by uncommenting this and choosing your languages
27+
# with:
28+
# languages: go, javascript, csharp, python, cpp, java
29+
30+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
31+
# If this step fails, then you should remove it and run the build manually (see below)
32+
- name: Autobuild
33+
uses: github/codeql-action/autobuild@v3
34+
35+
# ℹ️ Command-line programs to run using the OS shell.
36+
# 📚 https://git.io/JvXDl
37+
38+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
39+
# and modify them (or add more) to build your code if your project
40+
# uses a compiled language
41+
42+
#- run: |
43+
# make bootstrap
44+
# make release
45+
46+
- name: Perform CodeQL Analysis
47+
uses: github/codeql-action/analyze@v3

0 commit comments

Comments
 (0)