https://github.com/workleap/sg-web-configs
Common configurations for building web apps at ShareGate
https://github.com/workleap/sg-web-configs
Last synced: about 1 year ago
JSON representation
Common configurations for building web apps at ShareGate
- Host: GitHub
- URL: https://github.com/workleap/sg-web-configs
- Owner: workleap
- License: apache-2.0
- Created: 2023-01-11T20:35:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T01:36:43.000Z (over 1 year ago)
- Last Synced: 2025-03-17T13:17:52.678Z (about 1 year ago)
- Language: TypeScript
- Size: 399 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sg-web-configs
Common configurations for building web apps at ShareGate
[](./LICENSE.md)
[](https://github.com/gsoft-inc/sg-web-configs/actions/workflows/ci.yml)
## Usage
This repo is managed as a monorepo that is composed of many npm packages, where each package has its own README and documentation describing usage.
### Packages
| Name | NPM |
| --- | --- |
| [browserslist-config](packages/browserslist-config/README.md) | [](https://www.npmjs.com/package/@sharegate/browserslist-config) |
| [eslint-plugin](packages/eslint-plugin/README.md) | [](https://www.npmjs.com/package/@sharegate/eslint-plugin) |
| [postcss-plugin](packages/postcss-plugin/README.md) | [](https://www.npmjs.com/package/@sharegate/postcss-plugin) |
| [stylelint-plugin](packages/stylelint-plugin/README.md) | [](https://www.npmjs.com/package/@sharegate/stylelint-plugin) |
| [typescript-config](packages/typescript-config/README.md) | [](https://www.npmjs.com/package/@sharegate/typescript-config) |
## Contributing
### Make changes locally
1. Fork the repository.
- Using GitHub Desktop:
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
- Using the command line:
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
- GitHub Codespaces:
- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
2. Install or update to **Node.js v16**.
4. Create a working branch and start with your changes!
### Commit your update
Commit the changes once you are happy with them.
### Pull Request
When you're finished with the changes, create a pull request, also known as a PR.
- Run `npm run changeset` and follow the steps to generate a changeset file (that needs to be committed with your PR).
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
Once you submit your PR, a GSoft team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
## License
Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.