Hello Xuri,
Welcome to the pgadmin project.
Let us give you some guidelines/pointers to help you out starting.
As a general rule of thumb all the new development should be done in a
separate file that contain the functionality itself.
For Javascript,
- Has you might have notice we started some time ago the migration from
RequireJS into Webpack and ES6 for a more standardized way to develop and
we are trying no to touch the files are not ported yet.
You will need to connect the new functionality and will need to change
these files, but for that we would advise you to do something similar to
some code we have in SQLEditor:
_show_filter: function() {
let self = this;
FilterHandler.dialog(self);
},
- Create tests around your functionality
- If you are developing a panel like the History one in SQLEditor, do you
tthink you can use React to do it? History is an example of that
- We use ESLinter + Jasmine + Karma for linting and testing the javascript
side, be sure to run these before sending a patch
For Python:
- As advised in the Javascript part we are trying not to increase the
length of the current files as much as possible, so develop you backend in
a separate file(s) and then integrate them as normal classes of functions
in Python
- We use pycodestyle + Unittest for testing and linting, be sure to run
these before sending a patch
- Add tests around your functionality
If you need some more pointer or help in something let us know.
Thanks
Joao
On Wed, May 23, 2018 at 8:23 AM Xuri Gong <xurigo...@gmail.com> wrote:
> Hi Dave/Team,
>
> My name is Xuri Gong. I am working on implementing geospatial data viewer
> in pgAdmin4.
>
> I wrote a design document for the viewer[1] according to the related
> issue[2] and I am wondering if it is a proper design. It would be great if
> there are any suggestions.
>
> I have read the #pgAdmin Project Contributions# doc[3]. Is there any other
> instruction or standard that is needed to learn?
>
> [1]
> https://docs.google.com/document/d/1NE1RLTp9uw9fgduZEerrKKbQZEJCPyrSyQKa0-BDZsI/edit?usp=sharing
> [2] https://redmine.postgresql.org/issues/1407
> [3] https://www.pgadmin.org/docs/pgadmin4/dev/contributions.html
>
> Regards,
> Xuri Gong
>
