-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
56 additions
and
24 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,53 @@ | ||
| # Contributing to smashing.tools | ||
|
|
||
| ## Introduction | ||
|
|
||
| Welcome to smashing.tools! For an overview and technical details of our project, please visit our [README file on GitHub](https://github.com/smashing-team/smashing.tools/blob/contributing/README.md). We eagerly await your contributions and are excited about your participation. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| Before you begin, ensure you have installed: | ||
| - [Node v20.10.0](https://nodejs.org/en/download/) | ||
| - [Pnpm v8.12.0](https://pnpm.io/installation) | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ### Installation | ||
|
|
||
| To set up the development environment, follow these steps: | ||
| 1. Fork the GitHub repository. | ||
| 2. Clone your fork to your local machine: `git clone [your fork's URL]`. | ||
| 3. Navigate to the cloned directory: `cd [repository name]`. | ||
| 4. Install the required packages using Pnpm: `pnpm install`. | ||
| 5. Build the search index for Pagefind by running: `pnpm run build`. | ||
|
|
||
| ## Usage | ||
|
|
||
| To run the project locally: | ||
| 1. Start the project with `pnpm dev`. | ||
| 2. Open your browser and navigate to `http://localhost:4321`. | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### How to Contribute | ||
|
|
||
| 1. **Find a Task**: Look for open issues in the 'Issues' tab on GitHub. | ||
| 2. **Create a Branch**: In your fork, create a branch for your changes: `git checkout -b [your-branch-name]`. | ||
| 3. **Make Changes**: Code, debug, or update documentation as needed. | ||
| 4. **Commit Your Changes**: Commit your changes in a descriptive manner: `git commit -m "[your-commit-message]"`. | ||
| 5. **Push Your Changes**: Push your changes to your fork: `git push origin [your-branch-name]`. | ||
|
|
||
| ### Pull Request Process | ||
|
|
||
| 1. **Submit a PR**: On GitHub, click 'New pull request'. Choose your branch and provide a detailed description of your changes. | ||
| 2. **Review Process**: Be open to feedback and make necessary adjustments. | ||
| 3. **Merging**: Once approved, a maintainer will merge your PR into the main codebase. | ||
|
|
||
| ### Code of Conduct | ||
|
|
||
| Our community is committed to fostering a respectful and inclusive environment. Please adhere to our [Code of Conduct](https://github.com/smashing-team/smashing.tools/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License. See the [LICENSE file](https://github.com/smashing-team/smashing.tools/blob/main/LICENSE) for details. |
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 |
|---|---|---|
|
|
@@ -4,7 +4,8 @@ | |
| </a> | ||
| </kbd> | ||
| <div> </div> | ||
| <p align="center"> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://smashing.tools">Website</a> | ||
| · | ||
| <a href="https://github.com/orgs/smashing-team/projects/1">Roadmap</a> | ||
|
|
@@ -36,31 +37,9 @@ At smashing.tools, our vision is to be the go-to platform for developers seeking | |
| - **KeyStatic:** A simple static site generator ideal for lightweight and fast-loading web pages. | ||
| - **Netlify:** A cloud hosting service that automates deployment for web projects. | ||
|
|
||
| ## **Folder Structure** | ||
|
|
||
| ``` | ||
| smashing.tools/ | ||
| ├── src/ | ||
| │ ├── components/ # Mix of React and Astro components for UI versatility. | ||
| │ ├── content/ # Static content in Markdown for Astro-powered site. | ||
| │ ├── layouts/ # Layout templates defining UI structure. | ||
| │ ├── pages/ # Astro hybrid pages with static and dynamic content. | ||
| │ ├── plugins/ # Astro plugins for added functionality. | ||
| │ ├── styles/ # TailwindCSS styling for visual theme and design. | ||
| │ ├── types/ # TypeScript definitions for type safety and consistency. | ||
| │ ├── utils/ # Utility functions and helpers for common functionality. | ||
| ``` | ||
|
|
||
| ### **Getting Started** | ||
|
|
||
| - Clone the repository: `git clone [email protected]:smashing-team/smashing.tools.git 'smashing-tools'` | ||
| - Navigate to the project directory: `cd smashing-tools` | ||
| - Install the required packages using Pnpm: `pnpm install` | ||
| - Start the project: `pnpm dev` | ||
|
|
||
| ### **Contributing** | ||
|
|
||
| Thank you for considering contributing to Smashing.Tools! Before submitting your contributions, please review our [guidelines here](https://github.com/smashing-team/smashing.tools/blob/main/README.md). This guide contains detailed information on how you can contribute, code formatting, and more. | ||
| Thank you for considering contributing to smashing.tools! Before submitting your contributions, please review our [guidelines here](https://github.com/smashing-team/smashing.tools/blob/main/CONTRIBUTING.md). This guide contains detailed information on how you can contribute, code formatting, and more. | ||
|
|
||
| You can find more information by following the link and easily submit your contributions. | ||
|
|
||
|
|
||