Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
Code Issues Activity

fix: minor typos, formatting, and docs (#1512)

Browse source
This commit is contained in:
welling guzmán 2019-10-06 20:07:36 +02:00 committed by Juan Picado @jotadeveloper
parent 1d1a6829db
commit 549f4743d0
7 changed files with 102 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

132
.github/ISSUE_TEMPLATE/Bug_report.md vendored
View file

@ -1,66 +1,66 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
--- ---
<!-- <!--
Hi folk, please read carefully the following points, all this information is what you need to share and make the process efficient Hi folk, please read carefully the following points, all this information is what you need to share and make the process efficient
so eveyrbody can understand your issue, please notice if you don't fill any of this points our friendly boot will remind you to do it or so everybody can understand your issue, please notice if you don't fill any of this points our friendly boot will remind you to do it or
close automatically the issue. Removing the sections you considere are irrelevant for your issue is totally ok. close automatically the issue. Removing the sections you consider are irrelevant for your issue is totally ok.
If you have questions, you might rather join use over Discord https://chat.verdaccio.org If you have questions, you might rather join use over Discord https://chat.verdaccio.org
As reminder, we have code of conduct all of us we must follow https://github.com/verdaccio/verdaccio/blob/master/CODE_OF_CONDUCT.md As reminder, we have code of conduct all of us we must follow https://github.com/verdaccio/verdaccio/blob/master/CODE_OF_CONDUCT.md
--> -->
**Describe the bug** **Describe the bug**
<!-- A clear and concise description of what the bug is. --> <!-- A clear and concise description of what the bug is. -->
**To Reproduce** **To Reproduce**
<!-- How to reproduce the issue --> <!-- How to reproduce the issue -->
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
3. Scroll down to '....' 3. Scroll down to '....'
4. See error 4. See error
**Expected behavior** **Expected behavior**
<!-- A clear and concise description of what you expected to happen. --> <!-- A clear and concise description of what you expected to happen. -->
**Screenshots** **Screenshots**
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
**Docker || Kubernetes (please complete the following information):** **Docker || Kubernetes (please complete the following information):**
- Docker verdaccio tag: [e.g. verdaccio:4.x] - Docker verdaccio tag: [e.g. verdaccio:4.x]
- Docker commands [e.g. docker pull ...] - Docker commands [e.g. docker pull ...]
- Docker Version [e.g. v18.05.0-ce-rc1] - Docker Version [e.g. v18.05.0-ce-rc1]
**Configuration File (cat ~/.config/verdaccio/config.yaml)** **Configuration File (cat ~/.config/verdaccio/config.yaml)**
<!-- Please be careful do not leak any sensitive information, remove tokens --> <!-- Please be careful do not leak any sensitive information, remove tokens -->
**Environment information** **Environment information**
<!-- <!--
Please paste the results of `verdaccio --info` here (only if you are using >4.0.0). Please paste the results of `verdaccio --info` here (only if you are using >4.0.0).
Share, Node.js, node package manager used (npm, yarn or pnpm) and the version. Share, Node.js, node package manager used (npm, yarn or pnpm) and the version.
The verdaccio version is really important, run `verdaccio --version` if you don't know it. The verdaccio version is really important, run `verdaccio --version` if you don't know it.
--> -->
**Debugging output** **Debugging output**
<!-- If you are contributing and need to share internal stuff, here some useful commands to get more verbose output --> <!-- If you are contributing and need to share internal stuff, here some useful commands to get more verbose output -->
- `$ NODE_DEBUG=request verdaccio` display request calls (verdaccio <--> uplinks) - `$ NODE_DEBUG=request verdaccio` display request calls (verdaccio <--> uplinks)
- `$ DEBUG=express:* verdaccio` enable extreme verdaccio debug mode (verdaccio api) - `$ DEBUG=express:* verdaccio` enable extreme verdaccio debug mode (verdaccio api)
- `$ npm -ddd` prints: - `$ npm -ddd` prints:
- `$ npm config get registry` prints: - `$ npm config get registry` prints:
**Additional context** **Additional context**
<!-- <!--
If there is something else to share, screenshots, log files, or link references to other tickets. If there is something else to share, screenshots, log files, or link references to other tickets.
IMPORTANT: please do not attach log files, rather copy the content so is indexable for future search. IMPORTANT: please do not attach log files, rather copy the content so is indexable for future search.
--> -->

58
.github/ISSUE_TEMPLATE/Feature_request.md vendored
View file

@ -1,29 +1,29 @@
--- ---
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
--- ---
<!-- <!--
Verdaccio is a project addressed for voluntaries, if you appreciate this project considere to donate. Verdaccio is a project addressed for voluntaries, if you appreciate this project consider to donate.
1$/month - minimal contribution 1$/month - minimal contribution
5$/month - nice contribution 5$/month - nice contribution
500$ - help to promote this project, marketing, stickers. 500$ - help to promote this project, marketing, stickers.
2000$/year - sponsor status, your company logo will be in our readme, meetups talks and your request will have high priority 2000$/year - sponsor status, your company logo will be in our readme, meetups talks and your request will have high priority
https://opencollective.com/verdaccio https://opencollective.com/verdaccio
As reminder, the Open Source must be sustainable. As reminder, the Open Source must be sustainable.
--> -->
**Is your feature request related to a problem? Please describe.** **Is your feature request related to a problem?**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] Please describe a clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
**Describe the solution you'd like** **Describe the solution you'd like**
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
**Describe alternatives you've considered** **Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered. A clear and concise description of any alternative solutions or features you've considered.
**Additional context** **Additional context**
Add any other context or screenshots about the feature request here. Add any other context or screenshots about the feature request here.

2
CHANGELOG.md
View file

@ -57,7 +57,7 @@ All notable changes to this project will be documented in this file. See [standa
* fixed user creation endpoint to properly import groups ([50e115f](https://github.com/verdaccio/verdaccio/commit/50e115f)) * fixed user creation endpoint to properly import groups ([50e115f](https://github.com/verdaccio/verdaccio/commit/50e115f))
* remove stub type definition for handlebars ([de8dc43](https://github.com/verdaccio/verdaccio/commit/de8dc43)) * remove stub type definition for handlebars ([de8dc43](https://github.com/verdaccio/verdaccio/commit/de8dc43))
* unpublish and add or remove star colision ([#1434](https://github.com/verdaccio/verdaccio/issues/1434)) ([c264f94](https://github.com/verdaccio/verdaccio/commit/c264f94)) * unpublish and add or remove star collision ([#1434](https://github.com/verdaccio/verdaccio/issues/1434)) ([c264f94](https://github.com/verdaccio/verdaccio/commit/c264f94))
* **deps:** add missing prod dependency ([849f5bc](https://github.com/verdaccio/verdaccio/commit/849f5bc)) * **deps:** add missing prod dependency ([849f5bc](https://github.com/verdaccio/verdaccio/commit/849f5bc))

5
CONTRIBUTING.md
View file

@ -156,10 +156,9 @@ fix: xxxxxxxxxx
``` ```
Commits types such as as `docs:`,`style:`,`refactor:`,`perf:`,`test:` Commits types such as as `docs:`,`style:`,`refactor:`,`perf:`,`test:`
and `chore:` are valid but have no effect on versioning. **It would be great and `chore:` are valid but have no effect on versioning. **It would be great if you use them.**
if you use them.**
Use `npm run commitmsg` to check your commit message format. All commits message are going to be validated when they are created using husky hooks.
**PRs that do not follow the commit message guidelines will not be merged.** **PRs that do not follow the commit message guidelines will not be merged.**

4
README.md
View file

@ -120,7 +120,7 @@ This will prompt you for user credentials which will be saved on the `verdaccio`
## Docker ## Docker
Below are the most commonly needed informations, Below are the most commonly needed information,
every aspect of Docker and verdaccio is [documented separately](https://www.verdaccio.org/docs/en/docker.html) every aspect of Docker and verdaccio is [documented separately](https://www.verdaccio.org/docs/en/docker.html)
@ -245,7 +245,7 @@ Thanks to the following companies to help us to achieve our goals providing free
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
[![contrubitors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](../../graphs/contributors) [![contributors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](../../graphs/contributors)
### FAQ / Contact / Troubleshoot ### FAQ / Contact / Troubleshoot

2
conf/README.md
View file

@ -4,6 +4,6 @@ This directory host the default configuration file, but you can find more here:
* [https://verdaccio.org/docs/en/installation](https://verdaccio.org/docs/en/installation) * [https://verdaccio.org/docs/en/installation](https://verdaccio.org/docs/en/installation)
* [Chat with us](http://chat.verdaccio.org) <- You need a Discord account * [Chat with us](http://chat.verdaccio.org) <- You need a Discord account
* [Follou us on Twitter](https://twitter.com/verdaccio_npm) * [Follow us on Twitter](https://twitter.com/verdaccio_npm)
Enjoy Verdaccio ! Enjoy Verdaccio !

3
wiki/README.md
View file

@ -1,4 +1,3 @@
# Docs # Docs
Documentation was moved here [http://www.verdaccio.org](http://www.verdaccio.org/docs/en/installation.html) Documentation was moved to [https://www.verdaccio.org](https://www.verdaccio.org/docs/en/installation.html)