Documentation (neuralmagic#6)

TODO ENGINEERING:
Provided base files so technical content can be edited in new PRs; create new files as needed:

README.md, CONTRIBUTING.md, DEVELOPING.md

docs/available-models.md 

Created:
LICENSE, NOTICE, CODE_OF_CONDUCT.md

Author: jeanniefinks

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Community Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -1,2 +1,70 @@
-# How to contribute?
-[TODO: contribution instructions]
+# Contributing to SparseZoo
+
+If you’re reading this, hopefully we have piqued your interest to take the next step. Join us and help make SparseZoo even better! As a contributor, here are some community guidelines we would like you to follow:
+
+- [Code of Conduct](#code-of-conduct)
+- [Ways to Contribute](#ways-to-contribute)
+- [Bugs and Feature Requests](#bugs-and-feature-requests)
+- [Question or Problem](#question-or-problem)
+- [Developing SparseZoo](DEVELOPING.md)
+
+## Code of Conduct
+
+Help us keep the software inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) in order to promote an environment that is friendly, fair, respectful, and safe. We want to inspire collaboration, innovation, and fun!
+
+## Ways to Contribute
+
+Whether you’re a newbie, dabbler, or expert, we appreciate you jumping in.
+
+### Contributing Code
+
+- Make pull requests for addressing bugs, open issues, and documentation
+- Neural Magic as the maintainer will do reviews and final merge
+
+### Reporting In
+
+- See something, say something: bugs, documentation
+- Propose new feature requests to Neural Magic
+
+### Helping Others
+
+- Answer open discussion topics
+- Spread the word about SparseZoo
+- Teach and empower others. This is the way!
+
+## Bugs and Feature Requests
+
+Please search through existing issues and requests first to avoid duplicates. Neural Magic will work with you further to take next steps.
+
+- Go to: [GitHub Issues](https://github.com/neuralmagic/sparsezoo/issues)</br>
+
+For bugs, include:
+
+- brief summary
+- OS/Environment details
+- steps to reproduce (s.t.r.)
+- code snippets, screenshots/casts, log content, sample models
+- add the GitHub label "bug" to your post
+
+For feature requests, including SparseZoo model additions, include:
+
+- problem you’re trying to solve
+- community benefits
+- other relevant details to support your proposal
+- add the GitHub label "enhancement" to your post
+
+For documentation edits, include:
+
+- current state, proposed state
+- if applicable, screenshots/casts
+- add the GitHub label "documentation" to your post
+
+## Question or Problem
+
+- Go to: [GitHub Discussions](https://github.com/neuralmagic/sparsezoo/discussions/)
+
+Post all other questions including support or how to contribute. Don’t forget to search through existing discussions to avoid duplication! Thanks!
+
+## Developing SparseZoo
+
+Made it this far? Review [Developing SparseZoo](DEVELOPING.md) to get started.

DEVELOPING.md

@@ -0,0 +1,138 @@
+# Developing SparseZoo
+
+[TODO: ENGINEERING - ADJUST SECTION HEADERS AS RELEVANT TO SOFTWARE; REMOVE THESE TODO(S) AND EXAMPLES BELOW]
+
+[ENGINEERING: State OS/Environment reminder; requirements upfront]
+
+Here's some details to get started.
+
+## Basic Commands
+
+[TODO: ENGINEERING]
+
+**EXAMPLE: install commands?**
+
+```bash
+[ENGINEERING: INSERT HERE]
+```
+
+This will do [ENGINEERING: list out concise summary of what these command will do and what the use can expect to happen once installed]..
+
+**EXAMPLE: makefile commands?**
+
+```bash
+[ENGINEERING: INSERT HERE]
+```
+
+This will do [ENGINEERING: list out concise summary of what these command will do and what the use can expect to happen once installed].
+
+**EXAMPLE: test changes locally?**
+
+```bash
+[ENGINEERING: INSERT HERE]
+```
+
+This will do [ENGINEERING: list out concise summary of what these command will do and what the use can expect to happen once installed]..
+
+## Resources
+
+[TODO: ENGINEERING - What does the developer need to know?]
+
+- EXAMPLE: architecture docs?
+- EXAMPLE: how make a modifier? (separate doc)
+
+## GitHub Workflow
+
+1. Fork the `neuralmagic/sparsezoo` repository into your GitHub account: https://github.com/neuralmagic/sparsezoo/fork.
+
+2. Clone your fork of the GitHub repository, replacing `<username>` with your GitHub username.
+
+   Use ssh (recommended):
+
+   ```bash
+   git clone [email protected]:<username>/sparsezoo.git
+   ```
+
+   Or https:
+
+   ```bash
+   git clone https://github.com/<username>/sparsezoo.git
+   ```
+
+3. Add a remote to keep up with upstream changes.
+
+   ```bash
+   git remote add upstream https://github.com/neuralmagic/sparsezoo.git
+   ```
+
+   If you already have a copy, fetch upstream changes.
+
+   ```bash
+   git fetch upstream
+   ```
+
+4. Create a feature branch to work in.
+
+   ```bash
+   git checkout -b feature-xxx remotes/upstream/master
+   ```
+
+5. Work in your feature branch.
+
+   ```bash
+   git commit -a
+   ```
+
+6. Periodically rebase your changes
+
+   ```bash
+   git pull --rebase
+   ```
+
+7. When done, combine ("squash") related commits into a single one
+
+   ```bash
+   git rebase -i upstream/master
+   ```
+
+   This will open your editor and allow you to re-order commits and merge them:
+   - Re-order the lines to change commit order (to the extent possible without creating conflicts)
+   - Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits.
+
+8. Submit a pull-request
+
+   ```bash
+   git push origin feature-xxx
+   ```
+
+   Go to your fork main page
+
+   ```bash
+   https://github.com/<username>/sparsezoo
+   ```
+
+   If you recently pushed your changes GitHub will automatically pop up a `Compare & pull request` button for any branches you recently pushed to. If you click that button it will automatically offer you to submit your pull-request to the `neuralmagic/sparsezoo` repository.
+
+   - Give your pull-request a meaningful title.
+     You'll know your title is properly formatted once the `Semantic Pull Request` GitHub check
+     transitions from a status of "pending" to "passed".
+   - In the description, explain your changes and the problem they are solving.
+
+9. Addressing code review comments
+
+   Repeat steps 5. through 7. to address any code review comments and rebase your changes if necessary.
+
+   Push your updated changes to update the pull request
+
+   ```bash
+   git push origin [--force] feature-xxx
+   ```
+
+   `--force` may be necessary to overwrite your existing pull request in case your
+  commit history was changed when performing the rebase.
+
+   Note: Be careful when using `--force` since you may lose data if you are not careful.
+
+   ```bash
+   git push origin --force feature-xxx
+   ```