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

Adding build files #9

Merged
merged 6 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
50 changes: 50 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## Overview
<!--
READ ME FIRST:
Please answer *all* questions below and check off every point from the Essential Checklist!
If there is no corresponding issue number, fill in N/A where it says [fill_in_number_here] below in 1.
-->

1. This PR fixes or fixes part of #[fill_in_number_here][(fill_in_the_issue_link)].
2. This PR does the following: [Explain here what your PR does and why]
3. (For bug-fixing PRs only) The original bug occurred because: [Explain what
the cause of the bug was, and which PR introduced it]

## Essential Checklist

- [ ] The **PR title** starts with "Fix #bugnum: " or "Fix part of #bugnum: ...", followed by a short, clear summary of the changes.
- [ ] I have followed the build process and error check mentioned in the [readme file](https://github.com/oppia/guppy/blob/master/README.md).
- [ ] I have followed the [instructions for making a code change](https://github.com/oppia/oppia/wiki/Make-a-pull-request).
- [ ] I have assigned the correct reviewers to this PR (or will leave a comment with the phrase "@{{reviewer_username}} PTAL" if I don't have permissions to assign reviewers directly).
- [ ] The linter/Karma presubmit checks pass on my local machine, and my PR follows the [coding style guide](https://github.com/oppia/oppia/wiki/Coding-style-guide)).
- [ ] "Allow edits from maintainers" is checked. (See [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) for instructions on how to enable it.)


## Proof that changes are correct

<!--
Add videos/screenshots of the running development server with changes you made in the
`package.json` file to test Guppy changes and simultaneously test the interaction that uses Guppy,
first by creating them and then checking them in the preview tab of the exploration editor,
and please keep the developer console open in the meanwhile so that we can be assured
that changes are not causing any errors.

To be specific, your proof video should cover the following points:
1. `package.json` file with running development server
2. Creating the interaction while keeping the developer console open.
3. Previewing the interaction while keeping the developer console open.

When you make updates to the PR, please update these videos/screenshots as well.
You can remove videos/screenshots from previous versions of the PR.

The above should be done for all PRs, including short ones (e.g., a single-line change).
However, if the changes in your PRs are autogenerated via a script and you cannot
provide proof for the changes, then please leave a comment "No proof of changes
needed because {{Reason}}" and remove all the sections below.-->

## PR Pointers

- Never force push! If you do, your PR will be closed.
- To reply to reviewers, follow these instructions: https://github.com/oppia/oppia/wiki/Make-a-pull-request#step-5-address-review-comments-until-all-reviewers-approve
- Some e2e tests are flaky, and can fail for reasons unrelated to your PR. We are working on fixing this, but in the meantime, if you need to restart the tests, please check the ["If your build fails" wiki page](https://github.com/oppia/oppia/wiki/If-CI-checks-fail-on-your-PR).
- See the [Code Owner's wiki page](https://github.com/oppia/oppia/wiki/Oppia's-code-owners-and-checks-to-be-carried-out-by-developers) for what code owners will expect.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,30 @@ Yes! See the [contributors page](https://daniel3735928559.github.io/guppy/site/
[roadmap](https://daniel3735928559.github.io/guppy/site/doc/roadmap.html)
for an idea of where the project is heading.

## Build process
After making the changes in the Oppia's guppy fork, follow the below steps:
* To get started, make sure you are in the guppy directory, then run the following:
```
$ cd guppy
```
```
$ npm install --only=dev
```
* To build, do
```
$ npm run-script build-debug
```
* To run the tests and code coverage tools, do
```
$ npm test
```
## Error check
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error check --> Verifying your changes

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

After adding build changes on the local guppy directory, follow the below steps to ensure the changes made are correct.
* Go to ``oppia/package.json`` file on local system.
* Find the line with ``guppy-dev``, and change the path to your local guppy fork ([Example](https://github.com/oppia/guppy/pull/9#issuecomment-1967417760)).
* Now, restart the sever and manually test the guppy supported interaction thoroughly to ensure that the changes you made are not breaking any part of the code.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sever --> server

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you see my earlier comment? "You might want to add something along the lines of "attach the video proof above"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seanlip If I'm getting this correct, you have asked to add a Guppy-specific comment in the PR template under the video proof section. Please let me know?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, sorry, scratch that -- this is the README file, not the PR template.

I think no changes are needed here, sorry about that. Thanks for clarifying.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

* After that you are all set to make a PR!

## License

Guppy is licensed under the [MIT License](http://opensource.org/licenses/MIT).
Loading