Skip to content

Commit 0c8fb16

Browse files
fahimahammedfahimahammed
committed
add info
1 parent 399cecf commit 0c8fb16

2 files changed

Lines changed: 104 additions & 18 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to Learn PostgreSQL
2+
3+
Thank you for considering contributing to the **Learn PostgreSQL** project! Your contributions help improve the quality of this resource and are greatly appreciated.
4+
5+
## Hacktoberfest
6+
7+
This repository is open to contributions as part of **Hacktoberfest**. If you are participating in Hacktoberfest, follow the guidelines below to ensure that your pull request (PR) is accepted and counts toward your Hacktoberfest contributions.
8+
9+
### What is Hacktoberfest?
10+
11+
Hacktoberfest is a month-long event (October) that encourages people to contribute to open-source projects. Contributors must submit **four quality pull requests** to participating repositories to earn a Hacktoberfest T-shirt or plant a tree.
12+
13+
You can read more about Hacktoberfest [here](https://hacktoberfest.com).
14+
15+
## How to Contribute
16+
17+
1. **Fork the repository**: Start by forking this repository to your own GitHub account. Click the "Fork" button at the top right of this page.
18+
19+
2. **Clone the repository**: Clone your fork locally.
20+
```bash
21+
git clone https://github.com/fahimahammed/learn-postgresql.git
22+
```
23+
24+
3. **Create a branch**: Create a new branch to work on your changes.
25+
```bash
26+
git checkout -b your-branch-name
27+
```
28+
29+
4. **Make your changes**: Implement your changes. You can improve documentation, fix issues, or add new PostgreSQL learning content.
30+
31+
5. **Commit your changes**: After making changes, commit them with a descriptive message.
32+
```bash
33+
git add .
34+
git commit -m "Your descriptive commit message"
35+
```
36+
37+
6. **Push your changes**: Push the changes to your fork.
38+
```bash
39+
git push origin your-branch-name
40+
```
41+
42+
7. **Create a pull request**: Go to the original repository and create a pull request from your fork. Ensure you provide a detailed description of the changes you made.
43+
44+
## Contribution Guidelines
45+
46+
- **New to open source?** No problem! Feel free to start by reviewing the [issues](https://github.com/fahimahammed/learn-postgresql/issues) in this repository and addressing bugs, typos, or other enhancements.
47+
- **Documentation**: If you're improving the documentation (e.g., README, guides), make sure to use clear and concise language.
48+
- **Code Contributions**: If you're contributing code or examples, make sure your code is clean, follows best practices, and is well-documented.
49+
- **Respect Community Standards**: Please be kind and respectful to others in your interactions. We strive to maintain a welcoming and supportive community.
50+
51+
## Issues
52+
53+
Feel free to browse open issues or create new ones if you spot any problems or have suggestions. When creating an issue, try to provide as much information as possible.
54+
55+
## Review Process
56+
57+
Once you submit a pull request:
58+
- Your contribution will be reviewed by the maintainers.
59+
- Feedback may be provided, and updates may be requested to ensure the quality of the content.
60+
- Once everything looks good, your pull request will be merged!
61+
62+
## License
63+
64+
By contributing, you agree that your contributions will be licensed under the MIT License, as detailed in the [LICENSE](LICENSE) file.

‎README.md‎

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,66 @@
1+
12
# Learn PostgreSQL
23

3-
This repository provides a guide to learn PostgreSQL, an open-source relational database management system known for its stability, reliability, and robustness. PostgreSQL offers a wide range of features and supports various data types, making it a popular choice for applications that require high performance, scalability, and data integrity.
4+
Welcome to the **Learn PostgreSQL** repository! This guide provides comprehensive resources to help you understand and master **PostgreSQL**, a powerful open-source relational database management system known for its reliability, scalability, and extensive feature set. PostgreSQL supports a wide variety of data types and offers advanced functionality that makes it suitable for high-performance, data-intensive applications.
45

56
## Table of Contents
67

78
- [Introduction](#introduction)
8-
- [Features](#features)
9+
- [Key Features](#key-features)
910
- [Installation](psql/installation.md)
1011
- [Data Types](psql/data-types.md)
1112
- [Database Operations](psql/database.md)
12-
- [Table & Schemas](psql/table-schema.md)
13+
- [Tables & Schemas](psql/table-schema.md)
1314
- [Querying Data](psql/query.md)
14-
- [Clauses](psql/clauses.md)
15+
- [SQL Clauses](psql/clauses.md)
1516
- [Advanced Concepts](psql/advance.md)
1617
- [Contributing](#contributing)
1718
- [License](#license)
18-
- [Declaration](#declaration)
19+
- [Acknowledgements](#acknowledgements)
1920

2021
## Introduction
21-
PostgreSQL, also known as Postgres, has been in development since 1989 and has gained widespread popularity due to its powerful features and ability to handle high workloads. It offers advanced functionality such as multi-version concurrency control, triggers, foreign keys, and stored procedures, making it suitable for a wide range of applications. PostgreSQL is renowned for its compliance with ACID properties, ensuring data reliability and consistency in transactions.
2222

23-
## Features
23+
**PostgreSQL**, often referred to as **Postgres**, has been in active development since 1989 and has evolved into one of the most robust relational database management systems available today. Known for its **ACID compliance** (Atomicity, Consistency, Isolation, Durability), it ensures the reliability and integrity of your data. Its advanced features like **multi-version concurrency control (MVCC)**, **triggers**, **foreign keys**, and **stored procedures** make PostgreSQL a top choice for a wide range of applications, from small web apps to large enterprise systems.
24+
25+
Whether you're a beginner or an experienced developer, this guide will walk you through the essentials of PostgreSQL, from installation to advanced database management techniques.
26+
27+
## Key Features
28+
29+
PostgreSQL offers numerous features that make it stand out as a leading database management system:
30+
31+
- **ACID Compliance**: Guarantees data reliability and consistency in all transactions.
32+
- **JSON Support**: Offers robust support for handling JSON data, allowing for hybrid relational/NoSQL models.
33+
- **High Performance**: Optimized for speed, handling complex queries efficiently, even under heavy load.
34+
- **Security**: Provides secure authentication methods, encryption, and access control for data protection.
35+
- **Open Source**: Free to use, modify, and distribute under the PostgreSQL license.
36+
- **Replication & Clustering**: Supports replication for high availability and horizontal scaling.
2437

25-
PostgreSQL has a wide range of features that make it a powerful and popular relational database management system. Some of the key features include:
38+
## Getting Started
2639

27-
- ACID Compliance
28-
- JSON support
29-
- High Performance
30-
- Security
31-
- Open Source
32-
- Replication and Clustering
40+
To get started with PostgreSQL, follow the [installation guide](psql/installation.md) and dive into the core topics:
3341

42+
- [Data Types](psql/data-types.md): Learn about the variety of data types supported by PostgreSQL.
43+
- [Database Operations](psql/database.md): Understand how to perform essential operations such as creating databases and managing users.
44+
- [Tables & Schemas](psql/table-schema.md): Explore how to structure your data using tables and schemas.
45+
- [Querying Data](psql/query.md): Master SQL querying with `SELECT`, `JOIN`, and more.
46+
- [SQL Clauses](psql/clauses.md): Learn how to refine your queries with clauses like `WHERE`, `GROUP BY`, and `HAVING`.
47+
- [Advanced Concepts](psql/advance.md): Delve into more complex topics like indexing, stored procedures, and performance tuning.
3448

3549
## Contributing
3650

37-
Contributions to this repository are welcome. If you find any errors or have suggestions for improvement, please open an issue or submit a pull request. Your feedback is valuable and helps improve the quality of the content.
51+
We welcome contributions to enhance the content and usability of this repository. If you'd like to contribute:
52+
53+
1. Fork the repository.
54+
2. Make your changes in a new branch.
55+
3. Submit a pull request with a detailed explanation of your changes.
56+
57+
For more details, see the [contributing guide](CONTRIBUTING.md). This repository is also open to **Hacktoberfest** contributions—be sure to check the guidelines!
3858

3959
## License
4060

41-
This repository is licensed under the [MIT License](LICENSE). You are free to use, modify, and distribute the content in accordance with the terms and conditions of the license.
61+
This project is licensed under the [MIT License](LICENSE), allowing you the freedom to use, modify, and distribute the content as you see fit.
62+
63+
## Acknowledgements
64+
65+
This documentation was created with assistance from tools like **ChatGPT**, **Google Bard**, and various online resources. For more details, see the [declaration page](declaration.md).
4266

43-
## Declaration
44-
[Document Created with Assistance from ChatGPT, Google Bard, and Internet](declaration.md)

0 commit comments

Comments
 (0)