Merge branch 'update/community_docs' into 'main' (PR EarthWorksOrg#43)

Update documents and add CONTRIBUTING and CODE_OF_CONDUCT

CODE_OF_CONDUCT.md

@@ -0,0 +1,67 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+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, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+Community Impact: A violation through a single incident or series of actions.
+
+Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+
+Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to EarthWorks
+
+Thanks for taking the time to contribute!
+
+This guide is a work in progress. For now the best place to start is the [Wiki](https://github.com/EarthWorksOrg/EarthWorks/wiki) for documentation and guides, [Issues](https://github.com/EarthWorksOrg/EarthWorks/issues) for a problem or feature request, the [Pull Requests](https://github.com/EarthWorksOrg/EarthWorks/pulls) to add your own changes, or [Discussions](https://github.com/EarthWorksOrg/EarthWorks/discussions) for all other topics. Please search before posting to keep the duplicates low!
+
+## Code of Conduct
+
+The EarthWorks project and all participants are governed by our [Code of Conduct](https://github.com/EarthWorksOrg/EarthWorks/blob/main/CODE_OF_CONDUCT.md). Upholding this code and reporting any violations ensures the quality of our community. Thank you for the efforts to keep this an open and welcoming environment!
+

README.md

@@ -1,7 +1,12 @@
 # Earthworks
 
-<a href="https://trackgit.com">
-<img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/lkr44qwuwkgg22lsrolk" alt="trackgit-views" />
-</a>
+![trackgit-views](https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/lkr44qwuwkgg22lsrolk) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/EarthWorksOrg/EarthWorks/blob/main/LICENSE)
+
+EarthWorks is a community earth system model that strives to provide high-resolution climate-scale simulations. This work leverages and extends the [Community Earth System Model](https://github.com/ESCOMP/CESM) where possible to allow coupled runs of Atmosphere, Land, and Ocean components on a single grid with horizontal spacing (cell size) less than 4km.
+
+Help us out by contributing your ideas and changes! Read the [Contributors' Guide](https://github.com/EarthWorksOrg/EarthWorks/blob/main/CONTRIBUTING.md) for more info.
+
+Visit our [Wiki](https://github.com/EarthWorksOrg/EarthWorks/wiki) for instructions to get started and other guides.
+
+This work is made possible through collaboration of NSF NCAR, Colorado State University, and others.
 
-Please refer [Earthworks Wiki](https://github.com/EarthWorksOrg/EarthWorks/wiki) for documentation