|
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 | 1 |
|
5 | | -## Hacktoberfest |
| 2 | +# Contributing to Learn PostgreSQL |
6 | 3 |
|
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. |
| 4 | +Thank you for your interest in contributing to the **Learn PostgreSQL** project! Your help makes this resource better for everyone—whether by fixing typos, improving explanations, or adding new PostgreSQL tutorials. |
8 | 5 |
|
9 | | -### What is Hacktoberfest? |
| 6 | +## Hacktoberfest 2025 |
10 | 7 |
|
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. |
| 8 | +This repository is open for **Hacktoberfest 2025** contributions. Hacktoberfest is a month-long event in October that encourages participants to contribute to open-source projects. Completing **four quality pull requests** to participating repositories earns you a Hacktoberfest T-shirt or a tree planted in your name. |
12 | 9 |
|
13 | | -You can read more about Hacktoberfest [here](https://hacktoberfest.com). |
| 10 | +Learn more about Hacktoberfest [here](https://hacktoberfest.com). |
14 | 11 |
|
15 | 12 | ## How to Contribute |
16 | 13 |
|
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. |
| 14 | +1. **Fork the repository** – Click the "Fork" button at the top right of this page. |
| 15 | +2. **Clone your fork** – Clone it to your local machine: |
| 16 | + |
20 | 17 | ```bash |
21 | 18 | git clone https://github.com/fahimahammed/learn-postgresql.git |
22 | 19 | ``` |
| 20 | +3. **Create a branch** – Make a new branch for your work: |
23 | 21 |
|
24 | | -3. **Create a branch**: Create a new branch to work on your changes. |
25 | 22 | ```bash |
26 | 23 | git checkout -b your-branch-name |
27 | 24 | ``` |
| 25 | +4. **Make your changes** – Fix typos, improve guides, or add new PostgreSQL content. |
| 26 | +5. **Commit your changes** – Write a clear and descriptive commit message: |
28 | 27 |
|
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 | 28 | ```bash |
33 | 29 | git add . |
34 | | - git commit -m "Your descriptive commit message" |
| 30 | + git commit -m "Add guide for PostgreSQL JSON functions" |
35 | 31 | ``` |
| 32 | +6. **Push your branch** – Push your changes to your fork: |
36 | 33 |
|
37 | | -6. **Push your changes**: Push the changes to your fork. |
38 | 34 | ```bash |
39 | 35 | git push origin your-branch-name |
40 | 36 | ``` |
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. |
| 37 | +7. **Open a Pull Request** – Go to the original repository and submit a PR with a detailed description of your changes. |
43 | 38 |
|
44 | 39 | ## Contribution Guidelines |
45 | 40 |
|
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. |
| 41 | +* **New to open source?** Start by reviewing [issues](https://github.com/fahimahammed/learn-postgresql/issues) and fixing small bugs, typos, or formatting errors. |
| 42 | +* **Documentation** – Keep language clear and concise. Improve readability wherever possible. |
| 43 | +* **Code & Examples** – Ensure your code is clean, follows best practices, and includes comments when necessary. |
| 44 | +* **Community Standards** – Be respectful, kind, and supportive in all interactions. |
50 | 45 |
|
51 | 46 | ## Issues |
52 | 47 |
|
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. |
| 48 | +If you find a bug, have suggestions, or want to propose new content, feel free to [create an issue](https://github.com/fahimahammed/learn-postgresql/issues) with detailed information. |
54 | 49 |
|
55 | 50 | ## Review Process |
56 | 51 |
|
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! |
| 52 | +* Submitted PRs will be reviewed by maintainers. |
| 53 | +* Feedback may be provided, and updates requested to ensure quality. |
| 54 | +* Once approved, your PR will be merged into the main repository. |
61 | 55 |
|
62 | 56 | ## License |
63 | 57 |
|
64 | | -By contributing, you agree that your contributions will be licensed under the MIT License, as detailed in the [LICENSE](LICENSE) file. |
| 58 | +By contributing, you agree that your contributions will be licensed under the **MIT License** as detailed in the [LICENSE](LICENSE) file. |
0 commit comments