From b7cf9f31d70062213e8d9912b2d6cd071f17a774 Mon Sep 17 00:00:00 2001 From: Nickyshe Date: Mon, 2 Jun 2025 05:16:48 +0100 Subject: [PATCH 1/2] Docs: Update Contributing guide --- contributing.md | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/contributing.md b/contributing.md index e78d0e1..ec022da 100644 --- a/contributing.md +++ b/contributing.md @@ -29,9 +29,8 @@ Before contributing, read our [Code of Conduct](https://github.com/CodeDynasty-d Refer to the following channels to connect with fellow contributors or to stay up-to-date with news about JetPath: -* Join our project contributors on {name and link to online chat}.Discord -* Participate in our project meetings on {specify the day of the week and cadence} at {specify time and timezone}, where you can provide a status update or raise questions and concerns about your contributions. Use the following link to join: {link to online meeting space} -2-3 meetings monthly, Fridays +* Join our project contributors on [Discord](https://discord.codedynasty.dev/) + ## Before you start @@ -46,19 +45,21 @@ To set up your environment, perform the following actions: ### Developer -1. Fork the Repository: Click the **Fork** button at the top right of the repository page to create a copy under your GitHub account. +1. Fork the Repository -2. Clone your forked repository to your computer using the command below. Replace `yourusername` with your GitHub username: +2. Clone your forked repository to your local machine using the command below. ```bash git clone https://github.com//JetPath.git ``` -3. Navigate to the Project Directory: Change into the project folder using the command below. +Replace `yourusername` with your GitHub username + +3. Navigate to the Project Directory ```bash cd JetPath ``` -4. Install Dependencies: Install all necessary packages with npm: +4. Install Dependencies ```bash npm install @@ -70,14 +71,14 @@ This will download and set up all libraries the project depends on. ```bash git checkout -b your-feature-branch ``` -6. Run the Development Server: Start the local server to preview your changes +6. Start the local server to preview your changes ```bash npm run dev ``` Open your browser and click the URL shown in the terminal (usually http://localhost:4000). -7. Compile the Project: Run the following command to build the project for production +7. Run the following command to build the project for production ```bash npm run compile @@ -89,15 +90,15 @@ Feel free to ask questions or open an issue if you need help! ### Writers -1. Fork the Repository: Click the **Fork** button at the top right of the repository page to create a copy under your GitHub account. +1. Fork the Repository -2. Clone your forked repository to your computer using the command below. Replace with your GitHub username: +2. Clone your forked repository to your computer using the command below. ```bash git clone https://github.com//JetPath.git ``` -3. Navigate to the Project Directory: Change into the project folder using the command below. - +Replace with your GitHub username +3. Navigate to the Project Directory ```bash cd JetPath ``` @@ -117,11 +118,8 @@ git checkout -b your-feature-branch ```bash npx docmach ``` - -7. Push your branch to your fork and open a Pull Request to the main repository. - Open your browser and click the URL shown in the terminal (usually http://localhost:4000). - +7. Push your branch to your fork and open a Pull Request to the main repository. ### Troubleshoot @@ -257,11 +255,5 @@ Add any extra context, screenshots, or testing instructions. - [ ] Tests passed - [ ] Documentation updated ``` - -### Releases - -{Provide a description of the release process and cadence for the project, such as the source code.} - - --- \ No newline at end of file From 604f87a20a7d35e323bdabd88a0d54b8890c855e Mon Sep 17 00:00:00 2001 From: Nickyshe Date: Mon, 2 Jun 2025 05:20:51 +0100 Subject: [PATCH 2/2] Docs: Update contributing guide --- contributing.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/contributing.md b/contributing.md index ec022da..ca706f1 100644 --- a/contributing.md +++ b/contributing.md @@ -146,22 +146,23 @@ Read the [Google developers documentation writing style guide](https://developer To help us improve JetPath, please report any issues or bugs you encounter. Here’s how you can do it: -1. **Check existing issues**: Before creating a new issue, search the issue tracker to see if someone else has already reported the problem. -2. **Create a new issue**: If you can’t find an existing issue, click the **New issue** button and fill out the template provided. Make sure to include: -* Summarize the issue in a few words. +1. Before creating a new issue, search the issue tracker to see if someone else has already reported the problem. +2. If you can’t find an existing issue, click the **New issue** button and fill out the template provided. Make sure to include: + +* A summary the issue in a few words. * Explain the problem, including any error messages or unexpected behavior. * List the steps you took that led to the issue. * Describe what you expected to happen and what actually happened. * Attach any relevant screenshots or log files if applicable. -3. **Provide context**: If relevant, mention your environment for example, operating system, browser, version of JetPath. +3. If relevant, mention your environment for example, operating system, browser, version of JetPath. -4. **Use Labels**: Apply labels to categorize issues by type for eexample,bug, feature request, documentation. -5. **Prioritize**: Use priority labels for example, high, medium, low to indicate the urgency of the issue. +4. Apply labels to categorize issues by type for eexample,bug, feature request, documentation. +5. Use priority labels for example, high, medium, low to indicate the urgency of the issue. -6. **Comment and discuss**: Use the issue comments to discuss the problem and potential solutions with other contributors. +6. Use the issue comments to discuss the problem and potential solutions with other contributors. -By following these steps, we can efficiently track and resolve issues, ensuring JetPath continues to improve for everyone. +Following these steps will help us track and resolve issues, ensuring JetPath continues to improve for everyone. ### Commit messages Here are the types and description of commit messages @@ -191,7 +192,7 @@ refactor: reorganize src/utils for better modularity ### Branch creation -To keep our repository organized and make collaboration easier, please follow these guidelines when creating and naming branches: +To keep our repository organized and make collaboration easy, please follow these guidelines when creating and naming branches: Use a consistent prefix to indicate the type of work: