Skip to content
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
69 changes: 0 additions & 69 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,72 +9,3 @@ List of changes this PR includes
### Related Issues

List of related issues
Copy link
Contributor

Choose a reason for hiding this comment

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

why did we remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The template is too long. I kept the necessary data only.

Copy link
Contributor

Choose a reason for hiding this comment

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

it has constant reminders of what the PR creator needs to consider/check before requesting a code review

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used the same template as Kubecloud.


### Tested Scenarios

A list of scenarios tried to match the deliverables

### Documentation PR

For UI changes, Please provide the Documentation PR on [info_grid](https://github.com/threefoldtech/info_grid)

### To consider

#### Preliminary Checks:

- [ ] Preliminary Checks
- Does it completely address the issue linked?
- What about edge cases?
- Does it meet the specified acceptance criteria?
- Are there any unintended side effects?
- Does the PR adhere to the team's coding conventions, style guides, and best practices?
- Does it integrate well with existing features?
- Does it impact the overall performance of the application?
- Are there any bottlenecks or slowdowns?
- Has it been optimized for efficiency?
- Has it been adequately tested with unit, integration, and end-to-end tests?
- Are there any known defects or issues?
- Is the code well-documented?
- Are changes to documentation reflected in the code?

#### UI Checks:

- [ ] UI Checks
- If a UI design is provided/ does it follow it?
- Does every button work?
- Is the data displayed logical? Is it what you expected?
- Does every validation work?
- Does this interface feel intuitive?
- What about slow network? Offline?
- What if the gridproxy/graphql/chain is failing?
- What would a first time user have a hard time navigating here?

#### Code Quality Checks:

- [ ] Code Quality Checks
- Code formatted/linted? Are there unused imports? .. etc
- Is there redundant/repeated code?
- Are there conditionals that are always true or always false?
- Can we write this more concisely?
- Can we reuse this code? If yes, where?
- Will the changes be easy to maintain and update in the future?
- Can this code become too complex to understand for other devs?
- Can this code cause future integration problems?

### Testing Checklist

- [ ] Does it Meet the specified acceptance criteria.
- [ ] Test if changes can affect any other functionality.
- [ ] Tested with unit, integration, and end-to-end tests.
- [ ] Tested the un-happy path and rollback scenarios.
- [ ] Documentation updated to meet the latest changes.
- [ ] Check automated tests working successfully with the changes.
- [ ] Can be covered by automated tests.

### General Checklist

- [ ] Tests included
- [ ] Build pass
- [ ] Documentation
- [ ] Code format and docstring
- [ ] Screenshots/Video attached (needed for UI changes)
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @AhmedHanafy725 @zaelgohary @MohamedElmdary @Mahmoud-Emad @amiraabouhadid @AlaaElattar @0oM4R @samaradel
* @AhmedHanafy725 @zaelgohary @MohamedElmdary
18 changes: 2 additions & 16 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,6 @@ While you're creating a new release you also have to create a new tag the same a

Once you release, Publish workflow will start and will push the new released version to npm and build containers for the released projects.

## Create a new issue on [tf_operations](https://github.com/threefoldtech/tf_operations)
## Edit The [toml file](https://github.com/threefoldtech/home/blob/master/wiki/products/v3)

Create a new issue for each project of type `Update Request` (Playground & Stats) and mention the following:

- **Release link**

Make sure to change the '<tag>' in the link with the required tag

- **Charts directory link**

Links will differ as the per the package:

- [playground-charts](https://github.com/threefoldtech/tfgrid-sdk-ts/tree/<tag>/packages/playground/playground-charts/)

Newly created issue should look like this:

![image](https://user-images.githubusercontent.com/40770501/214016988-96a378a6-cb8b-4e15-aeb2-2c44576f9133.png)
Create a new toml file with the new release in v3 directory