-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: create pr template and update contributing guide (#931)
- Loading branch information
1 parent
6064526
commit ada02bd
Showing
4 changed files
with
61 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
### Before submitting the PR, please make sure you do the following: | ||
|
||
- [ ] Read the [Contributing Guidelines](https://github.com/AmadeusITGroup/AgnosUI/blob/main/CONTRIBUTING.md) | ||
- [ ] Reference your PR to an issue that was discussed ahead of time | ||
- [ ] The PR should contain a clear description of the problem it solves | ||
- [ ] Ideally, include a test that fails without this PR but passes with it. | ||
|
||
### Tests and linting | ||
|
||
- [ ] Run the unit tests with `npm run test` | ||
- [ ] Run the linting with `npm run lint` | ||
- [ ] Run the e2e tests with `npm run e2e` | ||
|
||
Thank you for contributing to AgnosUI! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing to AgnosUI | ||
|
||
We are always looking for quality contributions and will be happy to accept your Pull Requests. | ||
|
||
AgnosUI is a powerful library that provides configurable Typescript component factories, headless wrappers and ready-to-use components compliant to the [CSS Bootstrap design](https://getbootstrap.com/). | ||
|
||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful: | ||
|
||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
- [Building Welcoming Communities](https://opensource.guide/building-community/) | ||
|
||
## Organization of the repository | ||
|
||
This is a monorepo organised with multiple npm packages: | ||
|
||
- [`core`](core) contains the framework agnostic sources | ||
- [`core-bootstrap`](core-bootstrap) contains framework agnostic utilities / overrides for bootstrap support | ||
|
||
Each framework will include the following packages: | ||
|
||
- `headless` delivering the headless wrappers to use the core components with the selected framework | ||
- `bootstrap` delivering bootstrap-compliant implementations of the components, powered by the headless wrappers and the core components | ||
- `demo` the demo pages showcasing examples on how to the use the above packages. | ||
|
||
Finally, two other npm packages are available for testing purposes: | ||
|
||
- [`base-po`](base-po) contains a base class for page objects when writing end-to-end tests with Playwright | ||
- [`page-objects`](page-objects) contains page objects for each AgnosUI component | ||
|
||
## Getting Started | ||
|
||
If you want to play with AgnosUI on your own machine: | ||
|
||
- Clone the project | ||
- Run `npm install` | ||
- Run `npm run dev` | ||
- Open the page http://localhost:4000 | ||
|
||
To know more about the different commands you can run in local, please check the [DEVELOPER](DEVELOPER.md) documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters