diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..27063f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go do '...' +2. Run the following code + +```python +# Insert your code here +``` + +3. See error `...` + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**System details (please complete the following information):** + - OS: [e.g. Linux, macOS, Windows] + - Python Version [e.g. 3.9] + +**Additional context** +Add any other context about the problem here. diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..baf85b3 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant 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 e-mail 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 +te6s3z67 at duck dot com. +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][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..2f31605 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,103 @@ +# Contributing Guidelines + +We accept different types of contributions, +including some that don't require you to write a single line of code. + +## πŸ“ Types of contributions + +## Discussions πŸŽ‰ + +Discussions are where we have conversations. + +If have a great new idea, or want to share something amazing with the community, +join us in [discussions](https://github.com/weiji14/zen3geo/discussions). + +## Issues 🐞 + +[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) +are used to track tasks that contributors can help with. + +If you've found something in the content or the website that should be updated, +search open issues to see if someone else has reported the same thing. If it's +something new, [open an issue](https://github.com/weiji14/zen3geo/issues/new/choose)! +We'll use the issue to have a conversation about the problem you want to fix. + +## Pull requests πŸ› οΈ + +A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) +is a way to suggest changes in our repository. + +When we merge those changes, they should be deployed to the live site within a few minutes. +To learn more about opening a pull request in this repo, +see [Opening a pull request](#opening-a-pull-request) below. + +## Translations 🌏 + +δΊΊθ™½ζœ‰ε—εŒ—δΉ‹εˆ†οΌŒδ½†δ½›ζ€§ζœ¬ζ— ε—εŒ—γ€‚ + +Yes, the source content in this repository is mostly written in English, +but we welcome folks from across the world! Please reach out if you have experience in translations and are interested in contributing! + + +## πŸ‘ Opening a Pull Request + +1. [Login](https://github.com/login) to your GitHub account, + or sign up for a new one at https://github.com/signup. + +2. Navigate to the file you want to modify, e.g. the + [API docs file](https://github.com/weiji14/zen3geo/blob/main/docs/api.md). + +3. Click on the pen πŸ–ŠοΈ icon on the top right corner that says "Edit this file" + +4. This should bring you to a page similar to + https://github.com/weiji14/zen3geo/edit/main/docs/api.md + where you can make edits to the text using a web-based editor. + Feel free to switch between the "Edit file" and "Preview changes" tabs as + you modify the content to make sure things look ok. + +5. Once you're happy with your changes, scroll down to the bottom where it says + **Commit changes**. This is where you will add a short summary of the + changes you have made. + + ![The place to commit changes](https://user-images.githubusercontent.com/23487320/172029885-947e4e24-675a-4498-a2d8-f1fa4c26b934.png) + + Specifically, in the first box, you will need to give a short title (e.g. + "Fixed typo in api.md file") that describes the changes you've made. + Optionally, you can write a few extra sentences in the second box to explain + things in more detail. + +6. Select the "Create a new branch for this commit and start a pull request" + option and provide a new branch name (e.g. "fix-api-typo"). What this + does is to ensure your changes are made in an independent manner or 'branch' + away from the main trunk, and those changes will have the opportunity to be + double checked and openly reviewed by other people. + +7. Click on the green 'Propose changes' button. This will bring you to a new + page. + +8. Almost there! This "Open a pull request" page is where you can finalize + things for the 'pull request' (a request to make changes) you will be + opening soon. Again you will need to provide a title (e.g. 'Minor changes to + the API markdown file') and a description. + + ![Pull request dialog page](https://user-images.githubusercontent.com/23487320/172030066-63dbdaa3-c7d4-403f-a3b6-5bccd966d038.png) + + Be sure to provide any context on **why** you are making the changes, and + **how** you are doing so. This will make it easier for other people to + know what is happening when they review your changes. + +9. Ready? Click on the green 'Create pull request' button! This will make your + changes available for everyone to see and review publicly. The maintainers + will be notified about your great new addition and will get back to you on + the next steps. + +## πŸ₯³ And that's it! + +You're now part of the zen3geo community ✨ + +```{admonition} Credits +:class: seealso +*This contributing guide was adapted from* +[GitHub docs](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md) +and the [APECS-Earth-Observation/Polar-EO-Database](https://github.com/APECS-Earth-Observation/Polar-EO-Database/blob/main/CONTRIBUTING.md) project. +``` diff --git a/docs/_toc.yml b/docs/_toc.yml index e109069..1baabb4 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -4,4 +4,9 @@ format: jb-book root: index chapters: -- file: api + - title: πŸ“– API Reference + file: api + - title: 🫢 Code of Conduct + file: CODE_OF_CONDUCT + - title: πŸ§‘β€πŸ€β€πŸ§‘ Contributing + file: CONTRIBUTING