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
| Henri Yandell |[hyandell](https://github.com/hyandell)| Amazon |
10
10
11
11
## Admin Responsibilities
12
12
@@ -24,4 +24,4 @@ Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and
24
24
25
25
### Adopt Organizational Best Practices
26
26
27
-
Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
27
+
Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.
3
2
4
-
5
3
**Our open source communities endeavor to:**
6
4
7
-
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
8
-
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
9
-
* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
10
-
* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
11
-
5
+
- Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
6
+
- Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
7
+
- Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
8
+
- Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
12
9
13
10
**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**
14
11
15
-
* The use of violent threats, abusive, discriminatory, or derogatory language;
16
-
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
17
-
* Posting of sexually explicit or violent content;
18
-
* The use of sexualized language and unwelcome sexual attention or advances;
19
-
* Public or private harassment of any kind;
20
-
* Publishing private information, such as physical or electronic address, without permission;
21
-
* Other conduct which could reasonably be considered inappropriate in a professional setting;
22
-
* Advocating for or encouraging any of the above behaviors.
23
-
* Enforcement and Reporting Code of Conduct Issues:
12
+
- The use of violent threats, abusive, discriminatory, or derogatory language;
13
+
- Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
14
+
- Posting of sexually explicit or violent content;
15
+
- The use of sexualized language and unwelcome sexual attention or advances;
16
+
- Public or private harassment of any kind;
17
+
- Publishing private information, such as physical or electronic address, without permission;
18
+
- Other conduct which could reasonably be considered inappropriate in a professional setting;
19
+
- Advocating for or encouraging any of the above behaviors.
20
+
- Enforcement and Reporting Code of Conduct Issues:
24
21
25
22
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
-[Developer Certificate of Origin](#developer-certificate-of-origin)
12
14
-[License Headers](#license-headers)
15
+
-[Java](#java)
16
+
-[Python](#python)
17
+
-[Shell](#shell)
13
18
-[Review Process](#review-process)
14
19
15
20
## Contributing to OpenSearch
@@ -22,7 +27,7 @@ OpenSearch is a community project that is built and maintained by people just li
22
27
23
28
#### opensearch-dashboards-test-library
24
29
25
-
opensearch-dashboards-test-library is the test utility library used by this project, it is already a published package in NPM. You can import the lastest version by installing from NPM registry
30
+
opensearch-dashboards-test-library is the test utility library used by this project, it is already a published package in NPM. You can import the lastest version by installing from NPM registry
$ npx cypress run --spec "cypress/integration/vanilla-opensearch-dashboards/*.js"
49
54
```
50
55
51
-
By default, it uses headless mode (hide the broswer) You can turn on the browser display by:
56
+
By default, it uses headless mode (hide the broswer) You can turn on the browser display by:
52
57
53
58
```
54
59
$ npx cypress run --spec "cypress/integration/vanilla-opensearch-dashboards/*.js --headed"
55
60
```
56
61
57
-
You can also manually trigger the test via browser UI by:
62
+
You can also manually trigger the test via browser UI by:
58
63
59
64
```
60
65
$ npx cypress open
61
66
```
62
67
63
68
And you can override certain cypress config or environment variable by appling additional cli arguments, for example to override the baseUrl and OpensearchUrl to test a remote endpoint:
69
+
64
70
```
65
71
$ npx cypress run --spec "cypress/integration/vanilla-opensearch-dashboards/*.js" --env "openSearchUrl=https://foo.com" --config "baseUrl=https://foo.com/_dashboards"
66
72
```
67
73
74
+
### Formatting
75
+
76
+
`prettier` is used to standardize formatting of files. You can format all files (new and existing) by running
77
+
78
+
```
79
+
$ npx prettier * --write
80
+
```
81
+
82
+
This should be done before opening a PR to keep checked-in code consistent.
83
+
68
84
## First Things First
69
85
70
86
1.**When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when it doubt, [open an issue](issues).
71
87
72
-
2.**Only submit your own work**(or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
88
+
2.**Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
73
89
74
90
## Ways to Contribute
75
91
@@ -130,7 +146,7 @@ By making a contribution to this project, I certify that:
130
146
sign-off) is maintained indefinitely and may be redistributed
131
147
consistent with this project or the open source license(s)
132
148
involved.
133
-
```
149
+
```
134
150
135
151
We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
136
152
@@ -156,12 +172,14 @@ New files in your code contributions should contain the following license header
0 commit comments