docs: improve doc structure (#33)

* fix build errors

* fix build errors

* docs: wip - improve doc structure

* update tsconfig

* docs: add CONTRIBUTING.md

* use rome instead of eslint

* update yarn lock

@types/jest.d.ts

@@ -1,5 +1,5 @@
 import {DataFrame} from "@polars/dataframe";
-import {Series} from "@polars/series/series";
+import {Series} from "@polars/series";
 
 declare global {
   namespace jest {
@@ -12,11 +12,11 @@ declare global {
        *
        * @example
        * ```
-       * >>> df = pl.Dataframe([pl.Series("int32": [1,2], pl.Int32)])
-       * >>> other = pl.Dataframe([pl.Series("int32": [1,2], pl.UInt32)])
+       * > df = pl.Dataframe([pl.Series("int32": [1,2], pl.Int32)])
+       * > other = pl.Dataframe([pl.Series("int32": [1,2], pl.UInt32)])
        *
-       * >>> expect(df).toFrameEqual(other) // passes
-       * >>> expect(df).toFrameStrictEqual(other) // fails
+       * > expect(df).toFrameEqual(other) // passes
+       * > expect(df).toFrameStrictEqual(other) // fails
        * ```
        */
       toFrameStrictEqual(b: DataFrame): R;

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to nodejs-polars
+
+First of all, thank you for considering contributing to nodejs-polars!
+
+The following is a set of guidelines for contributing to nodejs-polars. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/pola-rs/nodejs-polars/issues).
+
+- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+- If possible, use the relevant bug report templates to create the issue.
+
+### Suggesting Enhancements
+
+- Open a new GitHub issue in the [Issues](https://github.com/pola-rs/nodejs-polars/issues) with a **clear title** and **description**.
+
+- If possible, use the relevant enhancement request templates to create the issue.
+
+
+### Pull Requests
+
+- Fill in the required template
+- Use a descriptive title. *(This will end up in the changelog)*
+- In the pull request description, link to the issue you were working on.
+- Add any relevant information to the description that you think may help the maintainers review your code.
+- Make sure your branch is [rebased](https://docs.github.com/en/get-started/using-git/about-git-rebase) against the latest version of the `main` branch.
+- Make sure all GitHub Actions checks pass.
+
+
+
+## Development
+### Vscode 
+If using VScode, it is recommended to install the following extensions
+- rust-analyzer 
+- rome
+---
+
+- Fork the repository, then clone it from your fork
+```
+git clone https://github.com/<your-github-username>/nodejs-polars.git
+```
+
+- Install dependencies
+```
+yarn install
+```
+
+- Build the binary
+```
+yarn build:debug
+```
+
+- Run the tests
+```
+yarn jest
+```
+
+- Make your changes
+- Test your changes
+- 
+You can run the `precommit` command to make sure all of your tests pass & code is formatted correctly.
+```
+yarn precommit
+```
+
+- Update the documentation if necessary
+- Create a new pull request

README.md

@@ -21,47 +21,45 @@ const pl = require('nodejs-polars');
 ### Series
 
 ```js
->>> const fooSeries = pl.Series("foo", [1, 2, 3])
->>> fooSeries.sum()
+> const fooSeries = pl.Series("foo", [1, 2, 3])
+> fooSeries.sum()
 6
 
 // a lot operations support both positional and named arguments
 // you can see the full specs in the docs or the type definitions
->>> fooSeries.sort(true)
->>> fooSeries.sort({reverse: true})
+> fooSeries.sort(true)
+> fooSeries.sort({reverse: true})
 shape: (3,)
 Series: 'foo' [f64]
 [
         3
         2
         1
 ]
->>> fooSeries.toArray()
+> fooSeries.toArray()
 [1, 2, 3]
 
 // Series are 'Iterables' so you can use javascript iterable syntax on them
->>> [...fooSeries]
+> [...fooSeries]
 [1, 2, 3]
 
->>> fooSeries[0]
+> fooSeries[0]
 1
 
 ```
 
 ### DataFrame
 
 ```js
->>> const df = pl.DataFrame(
+>const df = pl.DataFrame(
 ...   {
 ...     A: [1, 2, 3, 4, 5],
 ...     fruits: ["banana", "banana", "apple", "apple", "banana"],
 ...     B: [5, 4, 3, 2, 1],
 ...     cars: ["beetle", "audi", "beetle", "beetle", "beetle"],
 ...   }
 ... )
->>> df
-...   .sort("fruits")
-...   .select(
+> df.sort("fruits").select(
 ...     "fruits",
 ...     "cars",
 ...     pl.lit("fruits").alias("literal_string_fruits"),
@@ -90,7 +88,7 @@ shape: (5, 8)
 ```
 
 ```js
->>> df["cars"] // or df.getColumn("cars")
+> df["cars"] // or df.getColumn("cars")
 shape: (5,)
 Series: 'cars' [str]
 [

__tests__/complex_types.test.ts

@@ -1,19 +1,16 @@
 import pl from "@polars";
 
-
 describe("complex types", () => {
-
   test.skip("nested arrays round trip", () => {
     const arr = [[["foo"]], [], null];
     const s = pl.Series("", arr);
     const actual = s.toArray();
     expect(actual).toEqual(arr);
   });
   test.skip("struct arrays round trip", () => {
-    const arr = [{foo: "a", bar: 1}, null, null];
+    const arr = [{ foo: "a", bar: 1 }, null, null];
     const s = pl.Series("", arr);
     const actual = s.toArray();
     expect(actual).toEqual(arr);
   });
-
 });