Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Suraj Chafle committed Sep 20, 2022
0 parents commit 2c4888a
Show file tree
Hide file tree
Showing 28 changed files with 5,937 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
#src/bitbucket.org
#src/github.com
#src/code.google.com

# Web assests
web/
web.tar.gz

# IntelliJ file
.idea
go.iml
*.test
*.iml

# Visual Studio Code files
.vscode
.favorites.json

# Eclipse files
.project
.settings

# Stupid OSX
._.DS_Store
.DS_Store

# Hide fuse file for sshfs mounting from OSX
.fuse_*

# debian packages
*.deb

# Python
*.pyc

# Log files
*.log

# Distribution files
dist/

# Binary files
bin/

# Sonarqube
.scannerwork/

# Test coverage
*.coverprofile
coverage.out
coverage.stack
coverage.html
coverage.xml

# Unit test
*checkstyle.xml
*junit.xml
report.json

# Snyk
snyk.json

# Crash log files
crash.log

# Misc.
/environ.rc*
scrap*.*

# go module workspace file
go.work

90 changes: 90 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


<a name="v0.11.0"></a>
## v0.11.0 (2022-08-04)

### Bug Fixes

* **compare**: fixed the case where a type can have repetitive directives (b146008) [email protected]

### Chores

* **dependency**: updating gqlparser version (6c5f466) [email protected]


<a name="v0.10.0"></a>
## v0.10.0 (2022-07-27)

### Bug Fixes

* **make**: add 0 length to make to create slice (cc070c7) ECOMM-2581 [email protected]


<a name="v0.9.0"></a>
## v0.9.0 (2022-07-07)

### Refactors

* **common**: Update linter command to use common code (e129832) [email protected]


<a name="v0.8.0"></a>
## v0.8.0 (2022-06-28)

### Bug Fixes

* **compare**: error out if there are breaking changes in schema compare (81abb2f) [email protected]


<a name="v0.7.0"></a>
## v0.7.0 (2022-06-28)

### Features

* **compare**: Moved schema compare code from graphqlcompare repo (df92cb3) [email protected]


<a name="v0.6.0"></a>
## v0.6.0 (2022-06-27)

### Bug Fixes

* **rules**: fix the line number bug (ed88acd) [email protected]


<a name="v0.5.0"></a>
## v0.5.0 (2022-06-25)

### Features

* **linter**: support for wildcards in schema file path (3e333b2) [email protected]


<a name="v0.4.0"></a>
## v0.4.0 (2022-06-21)

### Refactors

* **linter**: moving code around to support multiple subcommands (2f94b9b) [email protected]


<a name="v0.3.0"></a>
## v0.3.0 (2022-06-16)

### Features

* **ui**: ability to enable/disable part of schema for linting (c3369e8) [email protected]


<a name="v0.2.0"></a>
## v0.2.0 (2022-05-26)

### Features

* **ui**: added help, users now can choose the rules to be applied; updated readme (58fc89f) [email protected]

85 changes: 85 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Contributing

_Welcome!_ We're excited you want to take part in the CrowdStrike community!

Please review this document for details regarding getting started with your first contribution, tools
you'll need to install as a developer, and our development and Pull Request process. If you have any
questions, please let us know by posting your question in the [discussion board](https://github.com/CrowdStrike/gql/discussions).

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How you can contribute](#how-you-can-contribute)
- [Pull Requests](#pull-requests)
- [License](#License)
- [Breaking changes](#breaking-changes)
- [Code Coverage](#code-coverage)
- [Commit Messages](#commit-message-formatting-and-hygiene)
- [Pull Request template](#pull-request-template)
- [Approval/Mergin](#approval--merging)

## Code of Conduct

Please refer to CrowdStrike's general [Code of Conduct](https://opensource.crowdstrike.com/code-of-conduct/)
and [contribution guidelines](https://opensource.crowdstrike.com/contributing/).

## How you can contribute

- See something? Say something! Submit a [bug report](https://github.com/CrowdStrike/gql/issues/new?assignees=&labels=bug%2Ctriage&template=bug.md&title=) to let the community know what you've experienced or found.
- Please propose new features on the discussion board first.
- Join the [discussion board](https://github.com/CrowdStrike/gql/discussions) where you can:
- [Interact](https://github.com/CrowdStrike/gql/discussions/categories/general) with other members of the community
- [Start a discussion](https://github.com/CrowdStrike/gql/discussions/categories/ideas) or submit a [feature request](https://github.com/CrowdStrike/gql/issues/new?assignees=&labels=enhancement%2Ctriage&template=feature_request.md&title=)
- Provide [feedback](https://github.com/CrowdStrike/gql/discussions/categories/q-a)
- [Show others](https://github.com/CrowdStrike/gql/discussions/categories/show-and-tell) how you are using `gql` today
- Submit a [Pull Request](#pull-requests)

## Pull Requests

All code changes should be submitted via a Pull Request targeting the `main` branch. We are not assuming
that every merged PR creates a release, so we will not be automatically creating new SemVer tags as
a side effect of merging your Pull Request. Instead, we will manually tag new releases when required.

### License
When you submit code changes, your submissions are understood to be under the same Unlicense [license](LICENSE) that covers the project.
If this is a concern, contact the maintainers before contributing.

### Breaking changes
In an effort to maintain backwards compatibility, we thoroughly unit test every Pull Request for all
versions of PowerShell we support. These unit tests are intended to catch general programmatic errors,
possible vulnerabilities and _potential breaking changes_.

Please fully document unit testing performed within your Pull Request. If you did not specify "Breaking Change" on the
punch list in the description, and the change is identified as possibly breaking, this may delay or prevent approval of your PR.

### Code Coverage

While we feel like achieving and maintaining 100% code coverage is often an untenable goal with
diminishing returns, any changes that reduce code coverage will receive pushback. We don't want
people to spend days trying to bump coverage from 97% to 98%, often at the expense of code clarity,
but that doesn't mean that we're okay with making things worse.

### Commit Message Formatting and Hygiene

We use [_Conventional Commits_](https://www.conventionalcommits.org/en/v1.0.0/) formatting for commit
messages, which we feel leads to a much more informative change history. Please familiarize yourself
with that specification and format your commit messages accordingly.

Another aspect of achieving a clean, informative commit history is to avoid "noise" in commits.
Ideally, condense your changes to a single commit with a well-written _Conventional Commits_ message
before submitting a PR. In the rare case that a single PR is introducing more than one change, each
change should be a single commit with its own well-written message.

### Pull Request template
Please use the pull request template provided, making sure the following details are included in your request:
+ Is this a breaking change?
+ Are all new or changed code paths covered by unit testing?
+ A complete listing of issues addressed or closed with this change.
+ A complete listing of any enhancements provided by this change.
+ Any usage details developers may need to make use of this new functionality.
- Does additional documentation need to be developed beyond what is listed in your Pull Request?
+ Any other salient points of interest.

### Approval / Merging
All Pull Requests must be approved by at least one maintainer. Once approved, a maintainer will perform the merge and execute any backend
processes related to package deployment. At this time, contributors _do not_ have the ability to merge to the `main` branch.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2022 CrowdStrike, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 2c4888a

Please sign in to comment.