-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from Firgrep/main
Major: added to contributions pages and edited staging workflow
- Loading branch information
Showing
12 changed files
with
248 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
NEXT_PUBLIC_SITE_ROOT="" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,6 +27,7 @@ yarn-error.log* | |
|
||
# local env files | ||
.env*.local | ||
.env | ||
|
||
# vercel | ||
.vercel | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
searchable: false | ||
--- | ||
|
||
import { Card, Cards } from 'nextra/components' | ||
|
||
# GitHub | ||
|
||
<Cards> | ||
<Card | ||
icon={" 📄 "} | ||
title="Conceptual Overview" | ||
href="/-contributing/github/conceptual-overview" | ||
/> | ||
<Card | ||
icon={""} | ||
title="Placeholder" | ||
href="/" | ||
/> | ||
<Card | ||
icon={""} | ||
title="Placeholder" | ||
href="/" | ||
/> | ||
<Card | ||
icon={""} | ||
title="Placeholder" | ||
href="/" | ||
/> | ||
</Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
searchable: false | ||
--- | ||
|
||
# GitHub: Conceptual Overview | ||
|
||
```mermaid | ||
graph TD; | ||
subgraph AA [Contributors] | ||
A[User 1]; | ||
B[User 2]; | ||
C[user 3]; | ||
end | ||
subgraph BB [Public] | ||
E[www]; | ||
end | ||
Z[GitHub Repository]; | ||
A --> Z; | ||
B --> Z; | ||
C --> Z; | ||
Z --> E; | ||
``` | ||
|
||
GitHub is a web-based platform designed to facilitate collaborative software development. It serves as a hub for developers to work together on coding projects, track changes, and manage their code repositories. At its core, GitHub uses a version control system called Git, which helps developers manage and track changes to their code. | ||
|
||
One of the fundamental concepts on GitHub is forking. Forking allows a user to create a copy of a repository (a collection of code files and related resources) from another user or organization's GitHub account. This forked repository becomes an independent copy of the original, enabling contributors to make changes without affecting the original codebase. This is particularly useful for suggesting improvements, fixing bugs, or adding new features. | ||
|
||
```mermaid | ||
graph TD; | ||
subgraph AA [User] | ||
A[Forked Repository]; | ||
end | ||
subgraph BB [sPhil] | ||
B[sPhil Reposotory]; | ||
end | ||
B --> A; | ||
``` | ||
|
||
Once you've forked a repository, you can clone it to your local development environment, which means you download a copy of the code to your computer, or you can interact directly with the code through GitHub. From whichever of the two development environment you choose to work from, you can make changes to the code as needed, following the project's guidelines or your own ideas for improvements. | ||
|
||
After making changes, you create a new branch within your forked repository. Branches are like separate lines of development that allow you to work on specific features or bug fixes without affecting the main codebase. Once you've finished making your changes in the branch, you can create a pull request (PR) to propose these changes to the original repository. | ||
|
||
A pull request is a request to the original repository's owner to review and merge your changes into their codebase. It includes a description of the changes, and the repository owner and collaborators can discuss the proposed changes, make additional comments, or request further modifications. Pull requests serve as a vital collaboration tool, enabling team members to evaluate code and ensure that it meets quality standards. | ||
|
||
```mermaid | ||
graph TD; | ||
subgraph AA [User] | ||
A[Forked Repository]; | ||
B[Makes and Commits Edits]; | ||
end | ||
subgraph BB [sPhil] | ||
Z[sPhil Reposotory]; | ||
end | ||
Z --> A; | ||
A --> B; | ||
B --> A; | ||
A -->|Pull Request| Z; | ||
``` | ||
|
||
If your pull request is approved and merged into the original repository, your contributions become part of the project, and others can benefit from your work. This collaborative workflow is central to GitHub's purpose, as it allows developers from around the world to work together, share knowledge, and collectively improve software projects. It also provides transparency and accountability in software development, making it easier for developers to track changes, understand the project's history, and maintain a high-quality codebase. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
searchable: false | ||
--- | ||
|
||
# Methodology | ||
|
||
## Spirit of the Method | ||
|
||
The spirit of the method of *sPhil* is deep exegesis of a philosophical system in order to develop and expose a definitive and comprehensive account of its contents. This account is split along an axis that has two ends: on one extreme, is user-friendliness and making knowledge as welcoming and accessible as possible; the other extreme is technical depth and exhaustiveness, where knowledge often requires a highly specialized vocabulary and irregular syntax. Ideally, both of these poles would be achieved in concert but instead of compromising one for the other, we have decided to run with the intensity of each and let the reader be conduit of both. These two poles are called *Guides* and *Reference*, inspired by how software engineers build their technical documentation split between on-boarding of new users and the pure functionality of the system. | ||
|
||
This does not, however, preclude overlap between the two poles and, indeed, some consideration is expected on the side of technical depth that the account should be readable, clear and well-structured just as on the side of introduction the matter should not be false or inaccurate. | ||
|
||
## Exegesis First | ||
|
||
The focus of *sPhil* accounts, whether they are in the Guides or Reference section, is on rendering the contents of a philosophical system explicit. There usually exists a vibrant scholarship around a philosophical system, and we invite contributors to make use of those wherever it is helpful or relevant, but we strongly encourage contributors to explicate the philosophy to the best of their ability rather than deferring that labor to someone else. In other words, the matter at hand should be explicated with only the primary source(s) to the best of one's ability before turning to second hand literature and scholarly disputations. This pattern is already widely used in *Wikipedia*, *The Stanford Encyclopaedia of Philosophy* and *nLab*, where a generic account is given first before turning to specifics and different interpretations, etc. | ||
|
||
## Non-neutral Standpoint | ||
|
||
We do not claim to keep or offer a neutral or non-commital view on a matter. In the realm of pure thinking, such a position cannot really be sustained since it is essentially pretending not to think. We do, however, aim to keep a self-critical and argued stance, where textual evidence is provided for a certain judgment or, where such evidence is lacking or unclear, a reasoned theory, and overall avoid untethered opinions. In other words, *sPhil* will not pretend to hold a view from nowhere but hold the best view developed through collaborative effort. |
Oops, something went wrong.