Skip to content

Commit

Permalink
Slim Infusion: Update baseline SLIM templates with core information. ...
Browse files Browse the repository at this point in the history
  • Loading branch information
jpl-jengelke committed Jan 19, 2024
1 parent 5d0f4e5 commit 74d37dc
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 57 deletions.
Binary file removed .github/.DS_Store
Binary file not shown.
39 changes: 9 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,6 @@ Thanks for taking the time to consider contributing! We very much appreciate you

Before you begin contributing to our project, it'll be a good idea to ensure you've satisfied the below pre-requisites.

### Developer Certificate of Origin (DCO)

To accept your contributions for any kind of patch, you'll want to:
1. Understand what a Developer Certificate of Origin is. See [this](https://wiki.linuxfoundation.org/dco) guide.
2. Read and agree to the [terms](https://developercertificate.org) of the Developer Certificate of Origin.
3. Remember to add your Sign-Off for each patch contribution you submit to our project via either:
1. By using the `-s` flag if using Git. See [these](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) instructions.
2. By including the following text in your patch contributions (i.e. pull requests)
```
Signed-off-by: Full Name <email>
```

Reviewers reviewing your patch will look for the sign-off before deciding to accept your contribution.

### License

Our project has our licensing terms, including rules governing redistribution, documented in our [LICENSE](LICENSE) file. Please take a look at that file and ensure you understand the terms. This will impact how we, or others, use your contributions.
Expand All @@ -28,10 +14,6 @@ Our project has our licensing terms, including rules governing redistribution, d

Our Code of Conduct helps facilitate a positive interaction environment for everyone involved with the team, and provides guidance on what to do if you experience problematic behavior. Read more in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and make sure you agree to its terms.

### Governance Model

Our Governance model helps outline our project's decision making and roles-based expectations. Read more in our [GOVERNANCE.md](GOVERNANCE.md).

### Developer Environment

For patch contributions, see our [Developer Documentation](https://github.com/NASA-AMMOS/3DTilesRendererJS/wiki) for more details on how to set up your local environment, to best contribute to our project.
Expand Down Expand Up @@ -75,8 +57,8 @@ Make sure people are aware you're working on a patch! Check out our [issue track
#### Choose the Right Branch to Fork

Our project typically has the following branches available, make sure to fork either the default branch or a branch someone else already tagged with a particular issue ticket you're working with.
- `develop` &mdash; default branch, used for new code development
- `main` &mdash; release branch
- `develop` &mdash; optional default branch, used primarily for new code development

### Make your Modifications

Expand All @@ -94,8 +76,6 @@ This makes sure that tickets are updated on GitHub with references to commits th

Commit should always be atomic. Keep solutions isolated whenever possible. Filler commits such as "clean up white space" or "fix typo" should be merged together before making a pull request, and significant sub-feature branches should be [rebased](https://www.youtube.com/results?search_query=git+rebase) to preserve commit history. Please ensure your commit history is clean and meaningful!

Additionally, remember to "Sign-Off" on your commits to align with our [Developer Certificate of Origin (DCO) policy](#developer-certificate-of-origin-dco).

### Submit a Pull Request

Pull requests are the core way our project will receive your patch contributions. Navigate to your branch on your own fork within the version control system, and submit a pull request or submit the patch text to our project.
Expand Down Expand Up @@ -182,7 +162,7 @@ Here's some guidance on submitting a new feature issue:

Security vulnerabilities should **not** be filed to the regular issue tracking system.

Report your security vulnerabilities to (see contact links): [@jl-0](https://github.com/jl-0) or [@jeffreypon](https://github.com/jeffreypon)
Report your security vulnerabilities to (see contact links): [@jl-0](https://github.com/jl-0) or [@sharimayer](https://github.com/sharimayer)

Please be sure to:
* Indicate the severity of the vulnerability
Expand Down Expand Up @@ -238,7 +218,7 @@ The overall structure of our project documentation is as follows:
- [README.md](README.md) - top-level information about how to run, build, and contribute to the project
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - best practices and guidance on how to work well with other people in the project, and suggestions on dealing with interpersonal issues
- [CONTRIBUTING.md](CONTRIBUTING.md) - guidance on contributing to the project
- `*.java` - inline documentation available inside code files
- `*.java`, `*.py`, `*.sh`, etc. - inline documentation available inside code files
- Hosted documentation
- [Wiki Main-page](https://github.com/NASA-AMMOS/3DTilesRendererJS/wiki)
- Discussion Boards
Expand Down Expand Up @@ -290,12 +270,10 @@ To ensure documentation is readable and consistent by newcomers and experts alik
#### Common Wording

Below are some commonly used words you'll want to leverage in your documentation contributions:
- **AMMOS** - Advanced Multi-Mission Operations System tool set.
- **Artifactory** - Lab-based artifact repository that stores compiled builds for reuse.
- **GitHub** - One word with capitalization of the 'G' and 'H'.
- **Jenkins** - Continuous Integration (CI) server that hosts many Lab builds.
- **MIPL** - Multimission Instrument Processing Lab which hosts the project containing this repository.
- **VICAR Java Build** - The build system that collects and compiles related code.
- **AMMOS** - Advanced Multi-Mission Operations System tool set. AMMOS is also the eponymous organization that sponsors this repository.
- **Docker** - Containerization service used to perform automated build, release and deployment.
- **GitHub** - one word, and capitalization of the 'G' and the 'H'
- **GitHub Actions** - Continuous Integration (CI) services that facilitate build automation

#### Inline Code Documentation

Expand Down Expand Up @@ -347,4 +325,5 @@ A great way to contribute towards our project goals is to socialize and encourag
- Help point project contributors and community members to conferences and publications where they may socialize their unique innovations
- Schedule in-person or virtual happy-hours to help create a more social atmosphere within the project community

For the above ideas, use our [communication channels](#communication-channels) to propose get-togethers.
For the above ideas, use our [communication channels](#communication-channels) to propose get-togethers.

39 changes: 12 additions & 27 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -175,33 +175,18 @@

END OF TERMS AND CONDITIONS

Copyright (c) 2022 California Institute of Technology ("Caltech").
U.S. Government sponsorship acknowledged.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and
the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials provided with the
distribution.
* Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the
names of its contributors may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2020 California Institute of Technology

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Binary file removed webdocs/.DS_Store
Binary file not shown.
Binary file removed webdocs/maven-logo-black-on-white.png
Binary file not shown.
Binary file removed webdocs/miplogo_mini.jpg
Binary file not shown.

0 comments on commit 74d37dc

Please sign in to comment.