Skip to content

Update: Contributing Guide #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update: Contributing Guide #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7cf9f3
Docs: Update Contributing guide
Nickyshe Jun 2, 2025
604f87a
Docs: Update contributing guide
Nickyshe Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 25 additions & 32 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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/<yourusername>/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
Expand All @@ -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
Expand All @@ -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 <yourusername> with your GitHub username:
2. Clone your forked repository to your computer using the command below.

```bash
git clone https://github.com/<yourusername>/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
```
Expand All @@ -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
Expand All @@ -148,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
Expand Down Expand Up @@ -193,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:

Expand Down Expand Up @@ -257,11 +256,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.}


---