You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -29,10 +29,10 @@ Here are a few guidelines that will help you along the way.
29
29
-[Release process](#release process)
30
30
-[Join the Project Team](#join-the-project-team)
31
31
32
-
## [Code of Conduct](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/blob/main/.github/CODE_OF_CONDUCT.md)
32
+
## [Code of Conduct](https://github.com/visulima/packem/blob/main/.github/CODE_OF_CONDUCT.md)
33
33
34
34
<\**ORGANIZATIONS*uppercase\*> has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it.
35
-
Please read [the full text](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/blob/main/.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
35
+
Please read [the full text](https://github.com/visulima/packem/blob/main/.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
36
36
37
37
## Introduction
38
38
@@ -47,9 +47,9 @@ The [Project Team](#join-the-project-team) looks forward to your contributions.
47
47
If you have a question about this project, how to use it, or just need clarification about something:
48
48
49
49
- First, search the issues to see if someone else already had the same problem as you.
50
-
- If not, open an GitHub Discussion at [Q&A](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/discussions/categories/q-a)
50
+
- If not, open an GitHub Discussion at [Q&A](https://github.com/visulima/packem/discussions/categories/q-a)
51
51
- Provide as much context as you can about what you're running into.
52
-
- Provide project and platform versions (nodejs, npm, etc) you can use `npx envinfo --system --npmPackages '@{{ SCOPED_PACKAGE_NAME }}/*' --binaries --browsers`, depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.
52
+
- Provide project and platform versions (nodejs, npm, etc) you can use `npx envinfo --system --npmPackages '@visulima/*' --binaries --browsers`, depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.
53
53
54
54
Once it's filed:
55
55
@@ -63,7 +63,7 @@ If you run into an error or bug with the project:
63
63
64
64
- First, search the open issues to see if someone else already reported this error or bug.
65
65
- If it's the case, add a +1 (thumb up reaction) to the issue and reply to the thread if you have something useful to add.
66
-
- If nobody submitted this error or bug, open an issue as [Bug report](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues/new?assignees=&labels=s%3A+pending+triage%2Cc%3A+bug&projects=&template=bug_report.yml) and follow the steps to create the report.
66
+
- If nobody submitted this error or bug, open an issue as [Bug report](https://github.com/visulima/packem/issues/new?assignees=&labels=s%3A+pending+triage%2Cc%3A+bug&projects=&template=bug_report.yml) and follow the steps to create the report.
67
67
> Include _reproduction steps_ that someone else can follow to recreate the bug or error on their own.
68
68
69
69
Once it's filed:
@@ -82,7 +82,7 @@ If the project doesn't do something you need or want it to do:
82
82
83
83
- First, search the open issues to see if someone else already requested that feature.
84
84
- If it's the case, add a +1 (thumb up reaction) to the initial request and reply to the thread if you have something meaningful to add.
85
-
- If nobody submitted this request, open an issue as [New feature proposal](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues/new?assignees=&labels=s%3A+pending+triage%2Cc%3A+feature%2Cs%3A+waiting+for+user+interest&projects=&template=feature_request.yml) and follow the steps to create the proposal.
85
+
- If nobody submitted this request, open an issue as [New feature proposal](https://github.com/visulima/packem/issues/new?assignees=&labels=s%3A+pending+triage%2Cc%3A+feature%2Cs%3A+waiting+for+user+interest&projects=&template=feature_request.yml) and follow the steps to create the proposal.
86
86
87
87
Once it's filed:
88
88
@@ -99,7 +99,7 @@ Working on your first Pull Request? You can learn how from this free video serie
99
99
100
100
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
101
101
102
-
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues?q=is:open+is:issue+label:%22good+first+issue%22) that contain bugs that have a relatively limited scope.
102
+
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/visulima/packem/issues?q=is:open+is:issue+label:%22good+first+issue%22) that contain bugs that have a relatively limited scope.
103
103
This is a great place to get started.
104
104
105
105
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix.
@@ -118,7 +118,7 @@ If you want to go the usual route and run the project locally, though:
> {{ ORGANIZATIONS_capitalize }} use nvm to manage the different node version, if you don't want to install `nvm`, check the package.json -> engines -> node value for the min support node version.
121
+
> Visulima use nvm to manage the different node version, if you don't want to install `nvm`, check the package.json -> engines -> node value for the min support node version.
122
122
-[Install pnpm](https://pnpm.io/installation)
123
123
-[Fork the project](https://guides.github.com/activities/forking/#fork)
124
124
@@ -131,7 +131,7 @@ Then in your terminal:
131
131
132
132
And you should be ready to go!
133
133
134
-
> If you run into any issue with the setup, check first the [TROUBLESHOOT.md](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/blob/main/.github/TROUBLESHOOT.md)
134
+
> If you run into any issue with the setup, check first the [TROUBLESHOOT.md](https://github.com/visulima/packem/blob/main/.github/TROUBLESHOOT.md)
135
135
136
136
## Contribute Documentation
137
137
@@ -517,7 +517,7 @@ Allowed scopes are:
517
517
518
518
> The scope is not checkable via `Semantic Pull Request` action as this would limit the scopes to only existing modules,
519
519
> but if we add a new package like `fs`, then the PR author couldn't use the new package name as scope.
520
-
> As such, we (the {{ ORGANIZATIONS_capitalize }} team) must be mindful of valid scopes, and we reserve the right to edit titles as we see fit.
520
+
> As such, we (the Visulima team) must be mindful of valid scopes, and we reserve the right to edit titles as we see fit.
521
521
522
522
Some examples of valid pull request titles:
523
523
@@ -621,7 +621,7 @@ If you can't do this yourself, @mention a maintainer so they can do it.
621
621
622
622
In order to help other folks out with their questions:
623
623
624
-
- Go to the GitHub discussions and [open the Q&A category](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/discussions/categories/q-a).
624
+
- Go to the GitHub discussions and [open the Q&A category](https://github.com/visulima/packem/discussions/categories/q-a).
625
625
- Read through the list until you find something that you're familiar enough with to give an answer to.
626
626
- Respond to the discussion with whatever details are needed to clarify the question, or get more details about what's going on.
627
627
- Once the discussion wraps up and things are clarified, either close the issue, or ask the original issue filer (or a maintainer) to close it for you.
@@ -632,15 +632,15 @@ Some notes on picking up support discussion:
632
632
- As much as possible, try to refer to past issues or discussion with accepted answers. Link to them from your replies with the `#123` format.
633
633
- Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient.
634
634
This is ok.
635
-
Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. (note: if the user is outright hostile or is violating the CoC, [refer to the Code of Conduct](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/blob/main/.github/CODE_OF_CONDUCT.md) to resolve the conflict).
635
+
Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. (note: if the user is outright hostile or is violating the CoC, [refer to the Code of Conduct](https://github.com/visulima/packem/blob/main/.github/CODE_OF_CONDUCT.md) to resolve the conflict).
One of the most important tasks in handling issues is labeling them usefully and accurately. All other tasks involving issues ultimately rely on the issue being classified in such a way that relevant parties looking to do their own tasks can find them quickly and easily.
642
642
643
-
In order to label issues, [open up the list of unlabeled issues](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!
643
+
In order to label issues, [open up the list of unlabeled issues](https://github.com/visulima/packem/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!
- label: "Follow our [Code of Conduct](https://github.com/visulima/packem/blob/main/.github/CODE_OF_CONDUCT.md)."
21
21
required: true
22
-
- label: "Read the [Contributing Guidelines](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/blob/main/.github/CONTRIBUTING.md)."
22
+
- label: "Read the [Contributing Guidelines](https://github.com/visulima/packem/blob/main/.github/CONTRIBUTING.md)."
23
23
required: true
24
-
- label: "Check that there isn't [already an issue](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues) that reports the same bug to avoid creating a duplicate."
24
+
- label: "Check that there isn't [already an issue](https://github.com/visulima/packem/issues) that reports the same bug to avoid creating a duplicate."
25
25
required: true
26
-
- label: "Make sure this is a {{ REPOSITORY_NAME }} issue and not related to a combination with another package."
26
+
- label: "Make sure this is a packem issue and not related to a combination with another package."
27
27
required: true
28
-
- label: "Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/discussions)."
28
+
- label: "Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/visulima/packem/discussions)."
29
29
required: true
30
30
- label: "The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug."
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.yml
+3-3
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ body:
9
9
id: "feature-description"
10
10
attributes:
11
11
label: "Clear and concise description of the problem"
12
-
description: "As a developer using @{{ SCOPED_PACKAGE_NAME }}/* I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!"
12
+
description: "As a developer using @visulima/* I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!"
13
13
validations:
14
14
required: true
15
15
- type: "textarea"
@@ -35,9 +35,9 @@ body:
35
35
label: "Validations"
36
36
description: "Before submitting the issue, please make sure you do the following"
- running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors
53
53
54
54
---
55
55
56
-
[View more issues which are waiting for user interest](https://github.com/{{ ORGANIZATIONS }}/{{ REPOSITORY_NAME }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22s%3A+waiting+for+user+interest%22+)`,
56
+
[View more issues which are waiting for user interest](https://github.com/visulima/packem/issues?q=is%3Aissue+is%3Aopen+label%3A%22s%3A+waiting+for+user+interest%22+)`,
0 commit comments