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: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ Mathesar's development happens on [GitHub](https://github.com/mathesar-foundatio
6
6
7
7
## Joining the Community
8
8
9
-
We highly recommend joining our [Matrix community](https://wiki.mathesar.org/en/community/matrix) and our [developer mailing list](https://wiki.mathesar.org/en/community/mailing-lists) before making contributions. This is where most of the core team's conversations about building Mathesar happen.
9
+
We highly recommend joining our [Matrix community](https://wiki.mathesar.org/community/matrix) and our [developer mailing list](https://wiki.mathesar.org/community/mailing-lists) before making contributions. This is where most of the core team's conversations about building Mathesar happen.
Make sure to **do this before moving on**. If you need help, ask in [Matrix](https://wiki.mathesar.org/en/community/matrix), taking care to form *specific* questions that people can answer asynchronously.
15
+
Make sure to **do this before moving on**. If you need help, ask in [Matrix](https://wiki.mathesar.org/community/matrix), taking care to form *specific* questions that people can answer asynchronously.
16
16
17
17
1.**Find an [issue](https://github.com/mathesar-foundation/mathesar/issues) to work on.**
- ❌ If an issue is _not_ labeled "help wanted", then it is not open to community contribution. One of the Mathesar maintainers will work on it instead.
22
22
- ❌ Issues already assigned to other users are also not open to contribution.
23
23
24
-
If you want to work on something for which there is no GitHub issue open yet, [create an issue](https://github.com/mathesar-foundation/mathesar/issues/new/choose) and propose your change there. A Mathesar [team member](https://wiki.mathesar.org/en/team) will evaluate your issue and decide whether we'll accept a pull request for the issue.
24
+
If you want to work on something for which there is no GitHub issue open yet, [create an issue](https://github.com/mathesar-foundation/mathesar/issues/new/choose) and propose your change there. A Mathesar [team member](https://wiki.mathesar.org/team) will evaluate your issue and decide whether we'll accept a pull request for the issue.
We encourage and appreciate code review by contributors. Feel free to review any open pull requests. Follow our [code review guidelines](https://wiki.mathesar.org/en/engineering/code-review).
59
+
We encourage and appreciate code review by contributors. Feel free to review any open pull requests. Follow our [code review guidelines](https://wiki.mathesar.org/engineering/code-review).
60
60
61
61
## Contributing documentation
62
62
@@ -68,5 +68,5 @@ We encourage and appreciate code review by contributors. Feel free to review any
68
68
69
69
Due to limited capacity, we are currently unable to accept design volunteers. Please return to this page for updates.
70
70
71
-
Please read through our [Design](https://wiki.mathesar.org/en/design) section to learn more about our design process.
71
+
Please read through our [Design](https://wiki.mathesar.org/archive/product/design/) section to learn more about our design process.
Mathesar is a web application that makes working with PostgreSQL databases both simple and powerful. It empowers users of all technical skill levels to view, edit, query, and collaborate on data with a familiar spreadsheet-like interface—no code needed. It’s self hosted, can be deployed in minutes, and works directly with PostgreSQL databases, schemas, and tables without extra abstractions. The project is 100% open source and maintained by Mathesar Foundation, a 501(c)(3) nonprofit.
18
18
19
19
Mathesar is as scalable as Postgres and supports any size or complexity of data, making it ideal for workflows involving production databases. It requires minimal setup, and integrates into your existing infrastructure. Because Mathesar is self-hosted, your data never leaves your servers, and access control based on Postgres roles and privileges keeps your database secure without adding unnecessary risk.
@@ -36,6 +36,8 @@ Mathesar is as scalable as Postgres and supports any size or complexity of data,
36
36
-[Linking two tables together](#linking-two-tables-together)
-[Viewing a single record with related records](#viewing-a-single-record-with-related-records)
39
+
-[Building a form](#building-a-form)
40
+
-[Filling out a form](#filling-out-a-form)
39
41
-[Viewing an Exploration (query result)](#viewing-an-exploration-query-result)
40
42
-[Building an Exploration (query)](#building-an-exploration-query)
41
43
-[Disconnecting a database](#disconnecting-a-database)
@@ -47,22 +49,27 @@ Mathesar is as scalable as Postgres and supports any size or complexity of data,
47
49
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
48
50
49
51
## Status
52
+
50
53
-[x]**Public Alpha**: You can install and deploy Mathesar on your server. Go easy on us!
51
54
-[x]**Public Beta**: Stable and feature-rich enough to implement in production
52
55
-[ ]**Public**: Widely used in production environments
53
56
54
57
We are currently in the **public beta** stage.
55
58
56
59
## Install Mathesar
60
+
57
61
Please see [our documentation](https://docs.mathesar.org/?ref=github-readme-installing) for instructions on installing Mathesar on your own server.
58
62
59
63
## Join our community
64
+
60
65
The Mathesar team is on [Matrix](https://wiki.mathesar.org/en/community/matrix) (chat service). We also have [mailing lists](https://wiki.mathesar.org/en/community/mailing-lists) and the core team discusses day-to-day work on our developer mailing list.
61
66
62
67
### Contribute to Mathesar
68
+
63
69
We actively encourage contribution! Get started by reading our [Contributor Guide](./CONTRIBUTING.md).
64
70
65
71
## Features
72
+
66
73
-**Built on Postgres**: Connect to an existing Postgres database or set one up from scratch.
67
74
-**Install in minutes**: Install using Docker in minutes, integrate into any existing infrastructure.
68
75
-**Postgres-based access control**: Use existing Postgres roles within Mathesar's UI, or set up your own.
@@ -71,13 +78,16 @@ We actively encourage contribution! Get started by reading our [Contributor Guid
71
78
-**Data entry**: Use our spreadsheet-like interface to view, create, update, and delete table records.
72
79
-**Filter, sort, and group**: Quickly slice your data in different ways.
73
80
-**Query builder**: Use our Data Explorer to build queries without knowing anything about SQL or joins.
81
+
-**Forms**: Build and share forms to collect data from anyone via a unique link, with submissions automatically saved as new records.
74
82
-**Import and export data**: Import and export data into Mathesar easily to work with your data elsewhere.
75
83
-**Schema migrations**: Transfer columns between tables in two clicks.
76
84
-**Uses Postgres features**: Mathesar uses and manipulates Postgres schemas, primary keys, foreign keys, constraints and data types. e.g. "Relationships" in the UI are foreign keys in the database.
77
85
-**Custom data types**: Custom data types for emails and URLs, validated at the database level.
Using databases shouldn't require technical expertise or expensive, closed-off tools. Databases are incredibly powerful, but they're often trapped behind complex interfaces that are hard to use or limit how people can access and share their data. We want to change that by building user-friendly tools that unlock the power of existing databases without sacrificing accessibility, portability, or extensibility.
118
136
119
137
Mathesar is our answer: an open-source platform designed to unlock the full potential of PostgreSQL, one of the most powerful and trusted open-source databases. Mathesar is easy to use, interoperable, and extensible, while also giving you complete control over your data. As a nonprofit, we're committed to keeping Mathesar 100% open source and available to everyone—because better ways to work with data mean better decisions, and better decisions lead to a better world.
120
138
121
139
## Bugs and troubleshooting
140
+
122
141
If you run into problems, refer to our [troubleshooting guide](./TROUBLESHOOTING.md).
123
142
124
143
## License
144
+
125
145
Mathesar is open source under the GPLv3 license - see [LICENSE](LICENSE). It also contains derivatives of third-party open source modules licensed under the MIT license. See the list and respective licenses in [THIRDPARTY](THIRDPARTY).
0 commit comments