You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-22Lines changed: 0 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,8 @@ WarpSQL is a powerful solution that provides opinionated extensions to Postgres,
44
44
By utilizing WarpSQL, you can benefit from the following:
45
45
46
46
• Simplified setup: With WarpSQL, you can have all the necessary extensions for your Postgres database in one go, saving you time and effort.
47
-
48
47
• Seamless integration: WarpSQL includes popular extensions like PgVector, TimescaleDB, Citus, and PostGIS, allowing you to leverage their functionality seamlessly.
49
-
50
48
• Enhanced performance: The included extensions are carefully selected to optimize database performance, enabling you to work efficiently with large datasets.
51
-
52
49
• Extensibility: While WarpSQL already supports a range of extensions, it aims to expand its offerings to include even more powerful tools in the future, such as ZomboDB, PLV8, and Pg Repack.
53
50
Get started with WarpSQL today and experience the convenience of a comprehensive Postgres solution.
54
51
@@ -64,15 +61,10 @@ Click the "Open in Gitpod" button above or use the following link:[Open in Gitpo
64
61
65
62
66
63
• Wait for the Gitpod environment to be created and initialized.
67
-
68
64
• Once the environment is ready, you can start working on the project.
69
-
70
65
• Make your desired changes or additions.
71
-
72
66
• Test your changes and ensure they meet the project's guidelines.
73
-
74
67
• Commit and push your changes to your forked repository.
75
-
76
68
• Create a pull request from your forked repository to the main WarpSQL repository.
77
69
78
70
## Development with GitHub Codespaces
@@ -83,11 +75,8 @@ You can use GitHub Codespaces to develop this project in the cloud.
83
75
84
76
85
77
• Click on the "Code" button.
86
-
87
78
• Select "Open with Codespaces" from the dropdown menu.
88
-
89
79
• Choose the appropriate Codespace configuration.
90
-
91
80
• Wait for the environment to be provisioned.
92
81
93
82
Once the environment is ready, you can start working on the project.
@@ -108,31 +97,20 @@ Install the project dependencies by running the following command in the termina
108
97
Before merging any contributions or changes, it's essential to ensure that the continuous integration (CI) tests pass successfully. CI helps maintain code quality standards and prevents the introduction of regressions. To ensure a smooth integration process, follow these steps:
109
98
110
99
• Make your desired changes or additions to the codebase.
111
-
112
100
• Run the relevant tests locally to verify that your changes are functioning as expected.
113
-
114
101
• Push your changes to the branch you're working on.
115
-
116
102
• The CI system will automatically run tests and checks on your code.
117
-
118
103
• Monitor the CI build status to ensure that all tests pass successfully.
119
-
120
104
• If the CI build fails, review the error messages and make the necessary fixes.
121
-
122
105
• Repeat steps 3-6 until the CI build passes successfully.
123
-
124
106
• Once the CI build is successful, you can proceed with merging your changes into the main WarpSQL repository.
125
107
126
108
127
109
## Publish the Project 
128
110
129
-
130
111
To publish the WarpSQL project, follow the guidelines below:
131
112
132
113
• Document the release process: Provide clear instructions on how to release new versions of the project. This may include steps to follow, release branches or tags, and any necessary checks or validations.
133
-
134
114
• Versioning conventions: Define the versioning scheme used for the project. It could be semantic versioning (e.g., MAJOR.MINOR.PATCH) or any other convention that aligns with the project's needs.
135
-
136
115
• Release notes: Prepare release notes for each new version, highlighting the changes, bug fixes, and new features included in the release. This helps users understand what to expect when upgrading to a new version.
137
-
138
116
• Distribution and deployment: Specify how the project should be distributed or deployed. If there are specific packages, containers, or deployment configurations, provide relevant documentation or instructions.
0 commit comments