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
{{ message }}
Repository navigation
Commit 700fb32
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+61-4Lines changed: 61 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,10 +61,67 @@ Enhancement suggestions are tracked as GitHub issues. Only recommendations that
61
61
62
62
## 📥 Pull Request Process
63
63
64
-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
65
-
2. Update the `README.md` with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
66
-
3. Increase the version numbers in any example files and the README.md to the new version that this Pull Request would represent.
67
-
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
64
+
To keep the project organized and maintain high-quality contributions, please follow the process below before submitting a pull request.
65
+
66
+
### 1️⃣ Prepare Your Changes
67
+
68
+
Before creating a pull request:
69
+
70
+
* Ensure your code runs correctly and does not introduce errors.
71
+
* Remove any unnecessary files such as temporary files, logs, or build artifacts.
72
+
* Make sure dependencies are clean and only required packages remain.
73
+
74
+
### 2️⃣ Keep the Project Clean
75
+
76
+
* Avoid committing compiled files, node modules, or environment-specific files.
77
+
* Ensure your code follows the project's existing structure and naming conventions.
78
+
* Test the application locally to verify that everything works as expected.
79
+
80
+
### 3️⃣ Update Documentation
81
+
82
+
If your changes affect the system, make sure to update the documentation:
83
+
84
+
* Update the **README.md** with clear explanations of the changes.
85
+
* Document any new environment variables, configuration steps, or setup instructions.
86
+
* Mention any new folders, APIs, or features introduced in your contribution.
87
+
88
+
### 4️⃣ Version Updates
89
+
90
+
If your contribution introduces noticeable improvements:
91
+
92
+
* Update version numbers where applicable.
93
+
* Mention the version update in the README or relevant configuration files.
94
+
* Provide a short summary of what changed in that version.
95
+
96
+
### 5️⃣ Write a Clear Pull Request
97
+
98
+
When submitting your PR:
99
+
100
+
* Use a clear and meaningful title.
101
+
* Provide a detailed description explaining what your changes do.
102
+
* Reference related issues if applicable.
103
+
* Add screenshots or examples when UI changes are involved.
104
+
105
+
### 6️⃣ Code Review Process
106
+
107
+
* Your pull request will be reviewed by project maintainers.
108
+
* Be open to feedback and make necessary improvements if requested.
109
+
* Ensure that your contribution aligns with the project's goals and coding standards.
110
+
111
+
### 7️⃣ Approval and Merge
112
+
113
+
* Once your PR receives approval from at least **two maintainers or reviewers**, it can be merged.
114
+
* If you do not have merge permissions, a maintainer will merge it for you after approval.
115
+
* Make sure all checks and discussions are resolved before requesting a merge.
116
+
117
+
### 8️⃣ After Merge
118
+
119
+
After your pull request is merged:
120
+
121
+
* Pull the latest changes from the main branch.
122
+
* Continue contributing by working on new issues or improvements.
Copy file name to clipboardExpand all lines: TUTORIAL.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,23 @@ Welcome to BiblioDrift! This comprehensive tutorial will guide you through disco
6
6
7
7
BiblioDrift is more than just a book finder—it's a sanctuary for readers who discover books through emotions and vibes rather than rigid categories. Imagine wandering through a warm, quiet bookstore where books practically whisper their stories to you.
8
8
9
+
10
+
## Why BiblioDrift is Different
11
+
12
+
Unlike traditional platforms that focus heavily on categories and algorithms, BiblioDrift emphasizes:
13
+
14
+
🎨 Visual-first discovery – Explore beautiful book covers and curated collections
15
+
16
+
💫 Emotion-based browsing – Find books by how you feel, not just by genre
0 commit comments