Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve repository with better documentation and templates #13501

Open
wants to merge 3 commits into
base: release-app-7.32
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tasks": {
"test": "ls .github",
"build": "echo \"No build process is required for this repository.\""
}
}
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Documentation Improvement
about: Suggest improvements to the documentation
title: ''
labels: 'documentation'
assignees: ''

---

**Describe the improvement**
A clear and concise description of the documentation improvement you are suggesting.

**Current state**
Describe the current state of the documentation that you want to improve.

**Additional context**
Add any other context or screenshots about the documentation improvement here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Question
about: Ask a question about the project
title: ''
labels: 'question'
assignees: ''

---

**Question**
A clear and concise description of your question.

**Relevant context**
Provide any relevant context or background information related to your question.

**Additional information**
Add any other information or screenshots that might help in answering your question.
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Description

<!-- Describe the changes you have made in this pull request. -->

## Related Issues

<!-- List any related issues or pull requests. -->

## Additional Context

<!-- Add any additional context or screenshots about the pull request here. -->
79 changes: 79 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# 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, 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 [INSERT CONTACT METHOD]. 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.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

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.
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to Postman App Support

Thank you for your interest in contributing to the Postman App Support repository! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.

## How to Contribute

1. **Fork the repository**: Click the "Fork" button at the top right corner of this repository to create a copy of the repository in your GitHub account.

2. **Clone the repository**: Clone the forked repository to your local machine using the following command:
```
git clone https://github.com/your-username/postman-app-support.git
```

3. **Create a new branch**: Create a new branch for your changes using the following command:
```
git checkout -b your-branch-name
```

4. **Make your changes**: Make the necessary changes to the codebase. Ensure that your changes follow the coding standards and guidelines of the project.

5. **Commit your changes**: Commit your changes with a clear and concise commit message using the following command:
```
git commit -m "Your commit message"
```

6. **Push your changes**: Push your changes to your forked repository using the following command:
```
git push origin your-branch-name
```

7. **Create a pull request**: Create a pull request (PR) from your forked repository to the main repository. Provide a detailed description of your changes and any relevant information.

## Guidelines for Contributing

- **Code Style**: Follow the coding style and conventions used in the project. Ensure that your code is clean, well-documented, and easy to understand.

- **Testing**: Write tests for your changes to ensure that they work as expected. Run the existing tests to make sure that your changes do not break any existing functionality.

- **Documentation**: Update the documentation if your changes affect the usage or functionality of the project. Ensure that the documentation is clear, concise, and up-to-date.

- **Issue Tracker**: Use the issue tracker to report bugs, request features, or discuss any issues related to the project. Provide as much detail as possible to help us understand and address the issue.

- **Code of Conduct**: Follow the project's code of conduct to maintain a positive and inclusive community. Be respectful, considerate, and constructive in your interactions with other contributors.

## Process and Expectations

- **Review Process**: Once you create a pull request, it will be reviewed by the project maintainers. They may provide feedback or request changes before merging your pull request. Please be responsive to their feedback and make the necessary changes.

- **Continuous Integration**: The project uses continuous integration (CI) to automatically run tests and checks on your pull request. Ensure that your changes pass all the CI checks before requesting a review.

- **Communication**: If you have any questions or need assistance, feel free to reach out to the project maintainers or other contributors. We are here to help and support you throughout the contribution process.

Thank you for your contributions and for helping to improve the Postman App Support repository!
40 changes: 40 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Pull Request Template

## Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
2 changes: 1 addition & 1 deletion release-notes/app-7.22.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Hello. We hope you’re safe and well. There’s a lot going on right now, so we

Get the latest version of the app here: https://www.postman.com/downloads/

### What’s new
### New Features
* We’re really excited to announce that Postman now supports writing RAML 1.0-type APIs. This new version brings a lot of new improvements including support for declaring Data Types, Libraries and Annotations, while also enhancing the way security schemas are written.
* See who’s in your workspace with new avatars next to the workspace menu. For workspaces with more than 3 users, click on the number next to the avatars for a full list of workspace members and to see who’s currently active. [Learn more](https://go.pstmn.io/docs-presence).
* Take a tour of the API Builder to learn how Postman can help you design, develop and manage your API throughout its lifecycle.
Expand Down
2 changes: 1 addition & 1 deletion release-notes/app-7.23.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hello! We hope you're staying safe and healthy. Here's what you can find in this Postman release:

### What's New
### New Features

* This release has an important security update: we're adding PKCE support for the Authorization Code Grant in OAuth 2.0 to help prevent authorization code interception attacks. (Fun fact: apparently, PKCE is pronounced "pixy." The more you know!)
[#3825](https://github.com/postmanlabs/postman-app-support/issues/3825)
Expand Down
6 changes: 5 additions & 1 deletion release-notes/app-7.24.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Postman v7.24.0

Hello! We hope you're staying safe and healthy. Here's what you can find in this Postman release:
### What's New

### New Features
* Some big changes to the API Builder that make creating and linking API elements even easier:
* When you generate a collection, you now have the additional option to create a mock server or monitor on top of that collection. If you'd rather create a collection from scratch for a monitor or mock server, you can also do that directly from the API Builder.
* You can generate collections for documentation and test suites from the "Develop" and "Test" tabs that are automatically linked to your API. Previously, you could only link existing collections.
Expand All @@ -9,12 +11,14 @@ Hello! We hope you're staying safe and healthy. Here's what you can find in this
[#7700](https://github.com/postmanlabs/postman-app-support/issues/7700),
[#8059](https://github.com/postmanlabs/postman-app-support/issues/8059)
* You can check in real-time whether your schema is synced to your GitHub repository.

### Improvements
* We've made various improvements to the code and description editors. Markdown descriptions have better syntax highlighting support now. In pre-request and test scripts, Postman variable suggestions now show up within relevant Postman Sandbox methods.
* You can now "move" a collection or API to another workspace. When sharing it to another workspace, select the option to remove it from the current workspace.
* Added additional import configurations for OpenAPI, RAML, and GraphQL files so that you can import your data exactly how you like it
[#82](https://github.com/postmanlabs/openapi-to-postman/issues/82)
* We've also optimized the workspace switcher modal for better performance.

### Bug Fixes
* Fixed an issue when importing schemas where path-level server objects in OpenAPI definitions were not handled correctly
[#160](https://github.com/postmanlabs/openapi-to-postman/issues/160)
Expand Down
2 changes: 1 addition & 1 deletion release-notes/app-7.25.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Postman v7.25.1

### What’s New
### New Features

* We now support system-wide theme in native dialogs and menus
[#5302](https://github.com/postmanlabs/postman-app-support/issues/5302)
Expand Down
2 changes: 1 addition & 1 deletion release-notes/app-7.25.2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Postman v7.25.2

### What's New
### New Features

* We now support the latest security protocol TLS v1.3 for your APIs
[#5628](https://github.com/postmanlabs/postman-app-support/issues/5628)
Expand Down
2 changes: 1 addition & 1 deletion release-notes/app-7.25.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hello! We hope you’re staying safe and healthy. Here’s what you can find in this Postman release:

### What’s New
### New Features

* This release introduces Viewer and Editor roles for environments [#6596](https://github.com/postmanlabs/postman-app-support/issues/6596)
* Viewers can access variable values to send requests and edit the Current Value
Expand Down
2 changes: 1 addition & 1 deletion release-notes/app-7.26.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hello! We hope you’re staying safe and healthy. Here’s what you can find in this Postman release:

### What's New
### New Features
* We’ve added support for an additional language when generating code snippets: You can now generate code snippets for Axios, to use in both the browser and node.js
[#135](https://github.com/postmanlabs/postman-code-generators/issues/135),
[#3822](https://github.com/postmanlabs/postman-app-support/issues/3822)
Expand Down
Loading