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: CONTRIBUTING.md
+110-38
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,17 @@
2
2
3
3
First off, thanks for taking the time to contribute! ❤️
4
4
5
-
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
6
-
7
-
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
5
+
All types of contributions are encouraged and valued. See the
6
+
[Table of Contents](#table-of-contents) for different ways to help and details
7
+
about how this project handles them. Please make sure to read the relevant
8
+
section before making your contribution. It will make it a lot easier for
9
+
us maintainers and smooth out the experience for all involved. The community
10
+
looks forward to your contributions. 🎉
11
+
12
+
> And if you like the project, but just don't have time to contribute, that's
13
+
> fine. There are other easy ways to support the project and show your
14
+
> appreciation, which we would also be very happy about:
15
+
>
8
16
> - Star the project
9
17
> - Tweet about it
10
18
> - Refer this project in your project's readme
@@ -21,103 +29,167 @@ All types of contributions are encouraged and valued. See the [Table of Contents
21
29
-[Styleguides](#styleguides)
22
30
-[Commit Messages](#commit-messages)
23
31
24
-
25
32
## Code of Conduct
26
33
27
34
This project and everyone participating in it is governed by the
28
35
[Palm CLI Code of Conduct](https://github.com/palmetto/palm-cli/blob/master/CODE_OF_CONDUCT.md).
29
36
By participating, you are expected to uphold this code. Please report unacceptable behavior
30
37
to <data-analytics-team@palmetto.com>.
31
38
32
-
33
39
## I Have a Question
34
40
35
-
> If you want to ask a question, we assume that you have read the available [Documentation](https://readthedocs.org/projects/palmetto-palm-cli/).
41
+
> If you want to ask a question, we assume that you have read the available
Before you ask a question, it is best to search for existing [Issues](https://github.com/palmetto/palm-cli/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
44
+
Before you ask a question, it is best to search for existing
45
+
[Issues](https://github.com/palmetto/palm-cli/issues) that might help you. In
46
+
case you have found a suitable issue and still need clarification, you can
47
+
write your question in this issue. It is also advisable to search the internet
48
+
for answers first.
38
49
39
-
If you then still feel the need to ask a question and need clarification, we recommend the following:
50
+
If you then still feel the need to ask a question and need clarification, we
51
+
recommend the following:
40
52
41
53
- Open an [Issue](https://github.com/palmetto/palm-cli/issues/new).
42
54
- Provide as much context as you can about what you're running into.
43
-
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
55
+
- Provide project and platform versions (nodejs, npm, etc), depending on
56
+
what seems relevant.
44
57
45
58
We will then take care of the issue as soon as possible.
46
59
47
60
## I Want To Contribute
48
61
49
-
### Legal Notice
50
-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
62
+
### Legal Notice
63
+
64
+
> When contributing to this project, you must agree that you have authored
65
+
> 100% of the content, that you have the necessary rights to the content and
66
+
> that the content you contribute may be provided under the project license.
51
67
52
68
### Reporting Bugs
53
69
54
70
#### Before Submitting a Bug Report
55
71
56
-
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
72
+
A good bug report shouldn't leave others needing to chase you up for more
73
+
information. Therefore, we ask you to investigate carefully, collect
74
+
information and describe the issue in detail in your report. Please complete
75
+
the following steps in advance to help us fix any potential bug as fast as
76
+
possible.
57
77
58
78
- Make sure that you are using the latest version.
59
-
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://readthedocs.org/projects/palmetto-palm-cli/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
60
-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/palmetto/palm-cli/issues?q=label%3Abug).
61
-
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
79
+
- Determine if your bug is really a bug and not an error on your side e.g.
80
+
using incompatible environment components/versions (Make sure that you have
81
+
read the [documentation](https://readthedocs.org/projects/palmetto-palm-cli/).
82
+
If you are looking for support, you might want to check
83
+
[this section](#i-have-a-question)).
84
+
- To see if other users have experienced (and potentially already solved) the
85
+
same issue you are having, check if there is not already a bug report
- Also make sure to search the internet (including Stack Overflow) to see if
89
+
users outside of the GitHub community have discussed the issue.
62
90
- Collect information about the bug:
63
91
- Stack trace (Traceback)
64
92
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
65
-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
93
+
- Version of the interpreter, compiler, SDK, runtime environment,
94
+
package manager, depending on what seems relevant.
66
95
- Possibly your input and the output
67
-
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
96
+
- Can you reliably reproduce the issue? And can you also reproduce it with
97
+
older versions?
68
98
69
99
#### How Do I Submit a Good Bug Report?
70
100
71
-
> You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <data-analytics-team@palmetto.com>.
101
+
> You must never report security related issues, vulnerabilities or bugs to the
102
+
issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by
103
+
email to <data-analytics-team@palmetto.com>.
72
104
73
-
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
105
+
We use GitHub issues to track bugs and errors. If you run into an issue with
106
+
the project:
74
107
75
-
- Open an [Issue](https://github.com/palmetto/palm-cli/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
108
+
- Open an [Issue](https://github.com/palmetto/palm-cli/issues/new). (Since we
109
+
can't be sure at this point whether it is a bug or not, we ask you not to
110
+
talk about a bug yet and not to label the issue.)
76
111
- Explain the behavior you would expect and the actual behavior.
77
-
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
112
+
- Please provide as much context as possible and describe the
113
+
_reproduction steps_ that someone else can follow to recreate the issue on
114
+
their own. This usually includes your code. For good bug reports you should
115
+
isolate the problem and create a reduced test case.
78
116
- Provide the information you collected in the previous section.
79
117
80
118
Once it's filed:
81
119
82
120
- The project team will label the issue accordingly.
83
-
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
84
-
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
85
-
86
-
121
+
- A team member will try to reproduce the issue with your provided steps. If
122
+
there are no reproduction steps or no obvious way to reproduce the issue, the
123
+
team will ask you for those steps and mark the issue as `needs-repro`. Bugs
124
+
with the `needs-repro` tag will not be addressed until they are reproduced.
125
+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as
126
+
well as possibly other tags (such as `critical`), and the issue will be left
127
+
to be [implemented by someone](#your-first-code-contribution).
87
128
88
129
### Suggesting Enhancements
89
130
90
-
This section guides you through submitting an enhancement suggestion for Palm CLI, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
131
+
This section guides you through submitting an enhancement suggestion for
132
+
Palm CLI, **including completely new features and minor improvements to
133
+
existing functionality**. Following these guidelines will help maintainers and
134
+
the community to understand your suggestion and find related suggestions.
91
135
92
136
#### Before Submitting an Enhancement
93
137
94
138
- Make sure that you are using the latest version.
95
-
- Read the [documentation](https://readthedocs.org/projects/palmetto-palm-cli/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
96
-
- Perform a [search](https://github.com/palmetto/palm-cli/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
97
-
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
139
+
- Read the [documentation](https://readthedocs.org/projects/palmetto-palm-cli/)
140
+
carefully and find out if the functionality is already covered, maybe by an
141
+
individual configuration.
142
+
- Perform a [search](https://github.com/palmetto/palm-cli/issues) to see if the
143
+
enhancement has already been suggested. If it has, add a comment to the
144
+
existing issue instead of opening a new one.
145
+
- Find out whether your idea fits with the scope and aims of the project. It's
146
+
up to you to make a strong case to convince the project's developers of the
147
+
merits of this feature. Keep in mind that we want features that will be
148
+
useful to the majority of our users and not just a small subset. If you're
149
+
just targeting a minority of users, consider writing an add-on/plugin library.
98
150
99
151
#### How Do I Submit a Good Enhancement Suggestion?
100
152
101
-
Enhancement suggestions are tracked as [GitHub issues](https://github.com/palmetto/palm-cli/issues).
- Use a **clear and descriptive title** for the issue to identify the suggestion.
104
157
- Use the feature request template as a framework for your suggestion.
105
-
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
106
-
-**Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
107
-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
108
-
-**Explain why this enhancement would be useful** to most Palm CLI users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
109
-
158
+
- Provide a **step-by-step description of the suggested enhancement** in as many
159
+
details as possible.
160
+
-**Describe the current behavior** and **explain which behavior you expected
161
+
to see instead** and why. At this point you can also tell which alternatives
162
+
do not work for you.
163
+
- You may want to **include screenshots and animated GIFs** which help you
164
+
demonstrate the steps or point out the part which the suggestion is related
165
+
to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs
Copy file name to clipboardExpand all lines: docs/source/branding/index.rst
+29-9
Original file line number
Diff line number
Diff line change
@@ -11,27 +11,47 @@ Brand Assets
11
11
============
12
12
.. toctree::
13
13
:titlesonly:
14
-
14
+
15
15
logos
16
16
17
-
Palm is empowering and inclusive by design, enabling Developers and Engineers
18
-
With diverse skill sets to create and evolve software without homogeneous programming know-how. With palm, contributors can focus on being experts in a way that generates the most value, and skip “sweating the small stuff” of rote interface memorization.
19
-
We are proud of what palm is and what it represents. These branding guidelines and associated assets are part of that representation and are intended to enhance and promote the public integrity of the project.
17
+
Palm is empowering and inclusive by design, enabling Developers and Engineers
18
+
With diverse skill sets to create and evolve software without homogeneous
19
+
programming know-how. With palm, contributors can focus on being experts in a
20
+
way that generates the most value, and skip “sweating the small stuff” of rote
21
+
interface memorization.
22
+
We are proud of what palm is and what it represents. These branding guidelines
23
+
and associated assets are part of that representation and are intended to
24
+
enhance and promote the public integrity of the project.
20
25
21
-
In plain words, we are proud of palm, and we want these branding guidelines and assets to be used freely in an open and positive way.
26
+
In plain words, we are proud of palm, and we want these branding guidelines
27
+
and assets to be used freely in an open and positive way.
22
28
23
29
Basic Use Guidelines
24
30
================
25
31
26
-
**1.1 Capitalization**:
27
-
Palm is an `improper (or common) <https://en.wiktionary.org/wiki/common_noun#English>`_ noun, and should follow appropriate grammar rules. Most notably, palm is spelled with a capital “P” (Palm) as the first word in a sentence, and with a lowercase “p” (palm) otherwise.
noun, and should follow appropriate grammar rules. Most notably, palm is
36
+
spelled with a capital “P” (Palm) as the first word in a sentence,
37
+
and with a lowercase “p” (palm) otherwise.
28
38
29
39
Logo Usage
30
40
=========
31
41
32
-
Palm :doc:`logos` can be used anywhere palm software is incorporated or used as part of a project or workflow, referenced, compared or combined. Basically, if you are using or discussing palm software, we encourage you to use palm logos as you see fit. Palm logos cannot be used for projects or as part of media unrelated to palm - for example, please do not open a nightclub named “Palm” and use our logo. If you are unsure if your use violates these guidelines, drop us a line at data-analytics-team@palmetto.com and we will be happy to advise.
42
+
Palm :doc:`logos` can be used anywhere palm software is incorporated or used
43
+
as part of a project or workflow, referenced, compared or combined. Basically,
44
+
if you are using or discussing palm software, we encourage you to use palm
45
+
logos as you see fit. Palm logos cannot be used for projects or as part of
46
+
media unrelated to palm - for example, please do not open a nightclub named
47
+
“Palm” and use our logo. If you are unsure if your use violates these
48
+
guidelines, drop us a line at data-analytics-team@palmetto.com and we will be
49
+
happy to advise.
33
50
34
51
Swag
35
52
====
36
53
37
-
We are excited that you are excited about palm! so feel free to create t-shirts, hats, parade floats etc with the palm logo for personal or team use. If you intend to sell palm-branded merchandise for profit, please drop us a line at data-analytics-team@palmetto.com so we can discuss.
54
+
We are excited that you are excited about palm! so feel free to create
55
+
t-shirts, hats, parade floats etc with the palm logo for personal or team use.
56
+
If you intend to sell palm-branded merchandise for profit, please drop us a
57
+
line at data-analytics-team@palmetto.com so we can discuss.
0 commit comments