Skip to content

Commit

Permalink
📝 Update the docs
Browse files Browse the repository at this point in the history
- Changed numbered list to bullet points
- Fix the broken link to the Code Of Conduct
  • Loading branch information
Soumesh Banerjee committed Jul 22, 2019
1 parent 00fed28 commit 26f0529
Show file tree
Hide file tree
Showing 10 changed files with 272 additions and 224 deletions.
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,5 +111,5 @@ deploy_github:
- echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
- git remote remove github &>/dev/null || true
- git remote add github git@github.com:espressif/${VSCODE_ESP_IDF_REPO}.git
- ./push_to_github.sh
- cd ci && ./push_to_github.sh
when: manual
2 changes: 2 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ src/**
.gitignore
tsconfig.json
menuconfig/js/test/**
.github
.cache
57 changes: 0 additions & 57 deletions ISSUE_TEMPLATE.md

This file was deleted.

244 changes: 94 additions & 150 deletions README.md

Large diffs are not rendered by default.

File renamed without changes.
76 changes: 76 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 vscode@espressif.com. 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
57 changes: 57 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to ESP-IDF Visual Studio Code Extension

:tada: Welcome and thank you for taking time to contribute to this project.

There are many ways that you can contribute, and this document will provide you a bird eye view of how to get going about it.

## Code of Conduct

This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [vscode@espressif.com](mailto:vscode@espressif.com).

## Reporting Issues

When you are about to open a new issue please make sure that you have scanned through the already opened issues to see if the issue or the feature request is already filed.

### Already Existing Issue

If you find your issue or feature request is already filed then properly comment or add reaction like "+1", furthermore you can subscribe to the issue to keep yourself up to date about the progress.

### Issue not existing

If you can't find the issue in the already opened issues then please make sure to file a bug report or feature request, while opening a issue or feature request please follow the templates presented to you.

### Git Commit Messages

- Reference the issue in the commit message just after the first line
- Consider starting the commit message with an [applicable emoji](https://gitmoji.carloscuesta.me)
- :art: `:art:` Improving structure / format of the code.
- :pencil2: `:pencil2:` Fixing typos.
- :zap: `:zap:` Improving performance.
- :fire: `:fire:` Removing files.
- :bug: `:bug:` Fixing a bug.
- :sparkles: `:sparkles:` Introducing new feature.
- :pencil: `:pencil:` Writing docs.
- :lipstick: `:lipstick:` Updating the web-view UI or style files
- :white_check_mark: `:white_check_mark:` Updating tests.
- :lock: `:lock:` Fixing security issues including npm dependencies audit.
- :apple: `:apple:` Fixing something on macOS.
- :penguin: `:penguin:` Fixing something on Linux.
- :checkered_flag: `:checkered_flag:` Fixing something on Windows.
- :construction: `:construction:` Work in progress.
- :see_no_evil: `:see_no_evil:` Adding or updating a .gitignore file
- :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` Merging branches.
- :rewind: `:rewind:` Reverting changes.
- :bookmark: `:bookmark:` Releasing / Version tags.
- :heavy_plus_sign: `:heavy_plus_sign:` Adding a dependency.
- :heavy_minus_sign: `:heavy_minus_sign:` Removing a dependency.
- :poop: `:poop:` Writing bad code that needs to be improved, just kidding please try to avoid this!

## I18N related contributions

Currently we support English and planing to expand to many other languages.

If you are willing to contribute any language translation, please read the [language contribution guideline](LANG_CONTRIBUTE.md).

## Forum

If you are lost at any point you can always ask question, help and suggestion in the [forum](https://esp32.com)
35 changes: 35 additions & 0 deletions docs/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug-github'

---

**Pre Bug Report Checklist**
Before reporting any bug please make sure of these points.

- [ ] Make sure you have searched for existing bugs and features request before you post an issue.
- [ ] This is a bug report for the ESP-IDF Visual Studio Code extension and **not** an ESP-IDF bug report.
- [ ] I've read the docs and found no information that could have helped solving the issue.

**Describe the bug**
A clear and concise description of what the bug is (current behavior).

**To Reproduce**
Steps to reproduce the behavior (including the full log).

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS Name & Version: [e.g. MacOS X 10.14.5]
- VSCode Version: [e.g. 1.35.1]
- ESP-IDF Version: [e.g. v3.2.2]
- Python Version: [e.g. 2.7.10]

**Additional context**
Add any other context about the problem here.
15 changes: 7 additions & 8 deletions LANG_CONTRIBUTE.md → docs/LANG_CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Language contribution guidelines.
# Language contribution guidelines

Make sure you install the source code version of this extension by following [Install using compressed source code](README.md#Installation-using-compressed-source-code-(espidf-vscode.tar.gz)).
Make sure you install the source code version of this extension by following [Source Mode](README.md#Source-Mode).

Inside i18n folder, create a sub-directory using the language code name as specified by [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) convention.

Expand All @@ -11,19 +11,18 @@ For ease you could copy the `en` for English definitions. A language folder shou
<IS0 639-3 Language Code>/
+-- out/
+-- extension.i18n.json
+-- idfComponentsDataProvider.i18n.json
+-- idfConfiguration.i18n.json
+-- MenuconfigPanel.i18n.json
+--- ...
+--- ...
+--- ...
+-- utils.i18n.json
+-- webViewContent.i18n.json
+-- package.i18n.json
```

Each file has a key value structure such as:

```
{
"espIdf.createFiles.title": "ESP-IDF: Create ESP-IDF project",
"espIdf.createFiles.title": "ESP-IDF: Create ESP-IDF project",
.
.
.
Expand All @@ -39,4 +38,4 @@ Test your contribution by changing Visual Studio Code locale:
- Pressing F1 and running the `Configure Display Language` command.
- Or manually modify `locale.json` in your Visual Studio Code User Settings.

Make a pull request with your contribution !
Make a pull request with your contribution, please follow the [Code of Conduct](CODE_OF_CONDUCT.md) while creating a pull request.
8 changes: 0 additions & 8 deletions hooks/pre-commit

This file was deleted.

0 comments on commit 26f0529

Please sign in to comment.