@@ -6,119 +6,132 @@ 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
9+ 1 . Please check the
10+ [ previously reported API issues] ( https://github.com/CPAN-API/cpan-api/issues )
11+ 2 . Please check the
12+ [ Wishlist] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) . If you can't
1113 find it already there:
1214 - 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 )
15+ [ wiki] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) (add a
16+ 'wishlist_MYIDEA' page if you need more space!)
17+ - If it's an actual bug
18+ [ create a new issue] ( https://github.com/CPAN-API/cpan-api/issues/new )
1619
1720#### If you are not sure, or it is related to https://metacpan.org/ front end:
1821
19221 . Please check the
2023 [ 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
24+ 2 . Please check the
25+ [ Wishlist] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) . If you can't
2226 find it already there:
2327 - 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!)
28+ [ wiki] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) (add a
29+ 'wishlist_MYIDEA' page if you need more space!)
2630 - If it's an actual bug
2731 [ create a new issue] ( https://github.com/CPAN-API/metacpan-web/issues/new )
2832
2933## Contributing code
3034
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.
35+ Come talk to us on IRC (see below), or send a pull request and we'll respond
36+ there. If you implement a new feature, please add a note about it to the News.md
37+ file at the top level of metacpan-web so that it will appear in our news feed.
3438
35- If you aren't using the VM, remember to enable the pre-commit hook before you start working.
39+ If you aren't using the VM, remember to enable the pre-commit hook before you
40+ start working.
3641
3742 sh git/setup.sh
3843
3944These links will get you going quickly:
4045
41- - [ Using our developer VM] ( https://github.com/CPAN-API/metacpan-developer ) to get you going in
42- minutes (depending on bandwidth)
46+ - [ Using our developer VM] ( https://github.com/CPAN-API/metacpan-developer ) to
47+ get you going in minutes (depending on bandwidth)
4348- [ Front end bug list] ( https://github.com/CPAN-API/metacpan-web/issues )
4449- [ 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
50+ - [ Wishlist] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) - things that
51+ probably need doing
4652
4753# Git workflow
4854
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.
55+ We try to keep a clean git history, so if it all possible, please rebase to get
56+ the latest changes from master _ before_ submitting a pull request. You'll only
57+ need to do the first command (git remote add) once in your local checkout.
5258
5359 git remote add upstream https://github.com/CPAN-API/metacpan-web.git
5460 git pull --rebase upstream master
5561
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.
62+ If you are comfortable rebasing, it is also helpful to squash or delete commits
63+ which are no longer relevant to your branch before submitting your work.
5864
5965 git rebase -i master
6066
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/ ) .
67+ If you are not comfortable with rebasing, but want to use it, check out the
68+ steps from [ here] ( https://help.github.com/articles/using-git-rebase/ ) .
6369
6470# Coding conventions
6571
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.
72+ Please try to follow the conventions already been used in the code base. This
73+ will generally be the right thing to do. Our standards are improving, so even if
74+ you do follow what you see, we may ask you to make some changes, but that is a
75+ good thing. We are trying to keep things tidy.
6976
70- If you are using the [ developer VM] ( https://github.com/CPAN-API/metacpan-developer ) you can run:
77+ If you are using the
78+ [ developer VM] ( https://github.com/CPAN-API/metacpan-developer ) you can run:
7179
7280``` sh
7381/home/vagrant/carton/metacpan-web/bin/tidyall
7482```
7583
7684## Perl Best Practices
7785
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.
86+ In general, the concepts discussed in "Perl Best Practices" are a good starting
87+ point. Use autodie where possible and MetaCPAN::Web::Types when creating new
88+ Moose attributes. Many of the other standards will be enforced by Perl::Critic.
8189
8290## Clear > Concise
8391
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.
92+ Take pains to use variable names which are easy to understand and to write
93+ readable code. We value readable code over concise code. Use singular nouns for
94+ class names. Use verbs for method names.
8695
8796## Try::Tiny > eval { ... }
8897
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.
98+ You will see many eval statements in the code. We would like to standardize on
99+ Try::Tiny, so feel free to swap out any eval with a Try::Tiny and use Try::Tiny
100+ in all new code.
91101
92102## Prefer single quotes
93103
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.
104+ Always use single quotes in cases where there is no variable interpolation. If
105+ there is a single quote in the quoted item, use curly quotes.
96106
97107q{Isn't this a lovely day};
98108
99109## Include a test (or more!)
100110
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.
111+ Any time when a pull request includes a test, it makes it easier for us to
112+ review and accept, so please do test your changes whenever possible. If your
113+ pull request includes visual changes, please include a before and after screen
114+ shot, so that we can better understand the problem you're trying to solve.
105115
106116## Dependencies
107117
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.
118+ Introducing new dependencies is fine, if they solve a specific problem which
119+ current dependencies cannot address. If we prefer a different module to be used,
120+ we'll let you know.
110121
111122## It's OK to be controversial
112123
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.
124+ If a pull request contains any controversial changes, we'll likely wait for some
125+ feedback from several developers before a merge. If you think your changes may
126+ be controversial, feel free to discuss them in a GitHub issue before starting to
127+ write any code.
116128
117129## Travis is your friend
118130
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.
131+ We use Travis to test all code changes. After submitting your pull request,
132+ remember to check back to see whether Travis has come back with any test
133+ failures. We do get some false negatives. If your pull request failed for
134+ reasons unrelated to your changes, we may still be able to merge your work.
122135
123136# Additional Resources
124137
@@ -133,11 +146,13 @@ pull request failed for reasons unrelated to your changes, we may still be able
133146
134147### When are issues closed?
135148
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.
149+ We want to keep the issue list manageable, so we can focus on what actually
150+ needs fixing. If you feel an issue needs opening again, please add a comment
151+ explaining why it needs re-opening and we'll look at it again.
139152
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
153+ - Issues will be closed and moved to
154+ [ Wishlist] ( https://github.com/CPAN-API/cpan-api/wiki/Wishlist ) if they are not
155+ actual bugs
142156- 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
157+ - Issues we are not going to take any further action on without more information
158+ will be closed
0 commit comments