Skip to content

Commit 10ff34b

Browse files
Updated README, LICENSE, CONTRIBUTING, CODE OF CONDUCT files; removed DISCLAIMER file.
1 parent 11b1b8f commit 10ff34b

14 files changed

+597
-320
lines changed

.bash_history

+495
Large diffs are not rendered by default.

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
node_modules
33
config.json
44
config
5+
.env

CODE_OF_CONDUCT.md

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
1-
Code of Conduct
2-
===============
1+
# US-EPA-CAMD Code of Conduct
2+
## Introduction
3+
We are committed to building a safe, friendly, and harassment-free culture for everyone. We pledge to interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
34

4-
All contributions to- and interactions surrounding- this project will abide by
5-
the [USGS Code of Scientific Conduct][1].
5+
## Scope
6+
This Code of Conduct applies to the [testorg-2020](https://github.com/testorg-2020) GitHub organization, its communications, events, and anyone participating in the US-EPA-CAMD GitHub community. Your use of our repositories means you accept and agree to abide by this Code of Conduct, and the [EPA Comment Policy,](https://www.epa.gov/web-policies-and-procedures/epa-comment-policy/) which will be periodically revised.
67

8+
## Expectations of Visitors and Contributors
9+
We expect all visitors and contributors to the US-EPA-CAMD GitHub organization and its repositories to have a safe and engaging experience that is beneficial to our community. Members of our community have a diverse set of experiences and skillsets. As you engage our community, please ensure you are:
10+
- Considerate: As an open source community, what you do will affect others. Ensure what you do is in the best interest of the project, and community at large.
11+
- Collaborative: The essence of open source is collaborative in nature. Be respectful of differing opinions and viewpoints.
12+
- Patient: Remember that open source is a culture change in government and while this repository is a testament to that change, change is occurring thanks to many in this community. Be patient if your question or issue is not answered right away.
13+
- Be mindful: Be aware of your actions, and others' actions. Treat people with empathy, dignity, and respect - the way you want to be treated.
14+
- Use clear communication: We don’t all speak the same language. Further, written or typed words may lack the tone or body language necessary to interpret intent or meaning. If your words could have more than one meaning, take time to be clear with your words and remember to be kind.
715

16+
## Unacceptable Behavior
17+
Users have a reasonable expectation to engage in our community free from harassment. Harassment can include but is not limited to offensive verbal comments related to gender, age, sexual orientation, disability, physical appearance, race, religion, deliberate intimidation, disruption of talks or events.
18+
Anything that is unlawful, objectionable, offensive, abusive, threatening, defamatory, obscene, hateful, inflammatory, profane, racially, sexually or religiously offensive is not permitted.
819

9-
[1]: https://www2.usgs.gov/fsp/fsp_code_of_scientific_conduct.asp
20+
## Enforcement
21+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct.
22+
23+
Unacceptable behavior from any community member, including those with decision-making authority, will not be tolerated. Anyone asked to cease unacceptable behavior is expected to comply immediately. If a community member engages in unacceptable behavior, the US-EPA-CAMD GitHub organization will take any action it deems appropriate, up to and including a temporary ban or permanent expulsion from the community without warning. This can include removal from email lists, team meetings, and repositories.
24+
25+
## Attribution
26+
This Code of Conduct is adapted from the following sources:
27+
- [Contributor Covenant](https://www.contributor-covenant.org/)
28+
- [Technology Transformation Services (TTS) Code of Conduct](https://18f.gsa.gov/code-of-conduct/)
29+
- [Consumer Financial Protection Bureau (CFPB) Code of Conduct](https://github.com/cfpb/consumerfinance.gov/blob/main/CODE_OF_CONDUCT.md)

CONTRIBUTING.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
Contributing
2-
============
1+
## Welcome!
32

4-
Contributions are welcome from the community. Questions can be asked on the
5-
[issues page][1]. Before creating a new issue, please take a moment to search
6-
and make sure a similar issue does not already exist. If one does exist, you
7-
can comment (most simply even with just a `:+1:`) to show your support for that
8-
issue.
3+
We’re so glad you’re thinking about contributing to an EPA open source project!
94

10-
If you have direct contributions you would like considered for incorporation
11-
into the project you can [fork this repository][2] and
12-
[submit a pull request][3] for review.
5+
Please be aware that this repository is currently undergoing testing, so it is likely we will not immediately address your issue or pull request as your idea may already be in our product roadmap.
136

7+
We encourage you to read this project’s CONTRIBUTING policy (you are here), its
8+
[LICENSE](https://github.com/testorg-2020/code-json-generator/blob/main/LICENSE), and its [README](https://github.com/testorg-2020/code-json-generator/blob/README.md).
149

10+
All contributions to this project will be released under the MIT dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.
1511

16-
[1]: https://github.com/usgs/inventory/issues
17-
[2]: https://help.github.com/articles/fork-a-repo/
18-
[3]: https://help.github.com/articles/about-pull-requests/
12+
If you have any questions or want to read more, check out the [EPA Open Source Project Repo](https://github.com/USEPA/open-source-projects) and [EPA's Interim Open Source Code Guidance](https://developer.epa.gov/guide/open-source-code/).

DISCLAIMER.md

-11
This file was deleted.

LICENSE.md

+21-46
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,21 @@
1-
License
2-
=======
3-
4-
Unless otherwise noted, This project is in the public domain in the United
5-
States because it contains materials that originally came from the United
6-
States Geological Survey, an agency of the United States Department of
7-
Interior. For more information, see the official USGS copyright policy at
8-
https://www2.usgs.gov/visual-id/credit_usgs.html#copyright
9-
10-
Additionally, we waive copyright and related rights in the work
11-
worldwide through the CC0 1.0 Universal public domain dedication.
12-
13-
14-
CC0 1.0 Universal Summary
15-
-------------------------
16-
17-
This is a human-readable summary of the
18-
[Legal Code (read the full text)][1].
19-
20-
21-
### No Copyright
22-
23-
The person who associated a work with this deed has dedicated the work to
24-
the public domain by waiving all of his or her rights to the work worldwide
25-
under copyright law, including all related and neighboring rights, to the
26-
extent allowed by law.
27-
28-
You can copy, modify, distribute and perform the work, even for commercial
29-
purposes, all without asking permission.
30-
31-
32-
### Other Information
33-
34-
In no way are the patent or trademark rights of any person affected by CC0,
35-
nor are the rights that other persons may have in the work or in how the
36-
work is used, such as publicity or privacy rights.
37-
38-
Unless expressly stated otherwise, the person who associated a work with
39-
this deed makes no warranties about the work, and disclaims liability for
40-
all uses of the work, to the fullest extent permitted by applicable law.
41-
When using or citing the work, you should not imply endorsement by the
42-
author or the affirmer.
43-
44-
45-
46-
[1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
1+
#MIT License
2+
3+
Copyright (c) 2020 U.S. Federal Government (in countries where recognized)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,11 @@ $ git push origin feature-X
116116
[3]: ./etc/config-example.json
117117
[4]: ./CODE_OF_CONDUCT.md
118118
[5]: ./CONTRIBUTING.md
119+
120+
### Credits
121+
122+
This repository reused material from [USGS code-json-generator repository](https://github.com/usgs/code-json-generator/).
123+
124+
### Disclaimer
125+
126+
The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use.  EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information.  Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA.  The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.

etc/config-example.json

+31-31
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
{
2-
"agency": "Department or Executive Agency ID",
3-
4-
"endpoints": [
5-
{
6-
"type": "github",
7-
"organization": "Your bureau/agency organization on GitHub",
8-
"username": "User with admin privileges for your organization on GitHub",
9-
"password": "Password for admin user for your organization on GitHub",
10-
"host": "api.github.com",
11-
12-
"exclude": [
13-
"Project to be excluded",
14-
"Another project to be excluded"
15-
],
16-
"minimumStatus": "Minimum status level to be included in inventory"
17-
},
18-
{
19-
"type": "gitlab",
20-
"organization": "Your bureau/agency team on GitLab",
21-
"username": "User with admin privileges for your team on GitLab",
22-
"password": "Password for admin user for your team on GitLab",
23-
"host": "gitlab.com",
24-
25-
"exclude": [
26-
"Project to be excluded",
27-
"Another project to be excluded"
28-
],
29-
"minimumStatus": "Minimum status level to be included in inventory"
30-
}
31-
]
32-
}
2+
"agency": "Department or Executive Agency ID",
3+
4+
"endpoints": [
5+
{
6+
"type": "github",
7+
"organization": "Your bureau/agency organization on GitHub",
8+
"username": "User with admin privileges for your organization on GitHub",
9+
"password": "Password for admin user for your organization on GitHub",
10+
"host": "api.github.com",
11+
12+
"exclude": [
13+
"Project to be excluded",
14+
"Another project to be excluded"
15+
],
16+
"minimumStatus": "Minimum status level to be included in inventory"
17+
},
18+
{
19+
"type": "gitlab",
20+
"organization": "Your bureau/agency team on GitLab",
21+
"username": "User with admin privileges for your team on GitLab",
22+
"password": "Password for admin user for your team on GitLab",
23+
"host": "gitlab.com",
24+
25+
"exclude": [
26+
"Project to be excluded",
27+
"Another project to be excluded"
28+
],
29+
"minimumStatus": "Minimum status level to be included in inventory"
30+
}
31+
]
32+
}

index.js

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
'use strict';
2+
require('dotenv').config();
3+
4+
console.log(process.env);
25

36

47
module.exports = {
@@ -12,8 +15,4 @@ module.exports = {
1215
GitHubClient: require('./github/client'),
1316
GitHubInventoryFactory: require('./github/inventory-factory'),
1417

15-
// GitLab module
16-
GitLab: require('./gitlab'),
17-
GitLabClient: require('./gitlab/client'),
18-
GitLabInventoryFactory: require('./gitlab/inventory-factory')
1918
}

lib/gitlab/client.js

-40
This file was deleted.

lib/gitlab/index.js

-7
This file was deleted.

0 commit comments

Comments
 (0)