dev oss

Getting Started with devoss

This guide takes you through contributing to devoss.tech and making your first open source contribution.

Code

Creating a New Post

Before proceeding with this post, I recommend reading the CONTRIBUTION GUIDELINES to get a complete overview of contributing to devoss.tech. This guide is specifically for contributing in the form of posts.

Setting Up Locally ⬇️

To contribute to devoss.tech, follow these steps to set up the project on your local machine:

  1. Fork the devoss repository to your GitHub account.

Fork Image

  1. Clone (or download) your forked repo to your local machine.
git clone https://github.com/{YOUR_GITHUB_USERNAME}/devoss.git

You can now open the devoss repository on your local machine.

  1. Open the terminal in the same path as the project, and run the following commands⚛️:
# Move to the devoss directory 
cd devoss  

# Install all the required dependencies 
npm install  

# Run the project on your local server 
npm run dev

Now you can access your app at localhost:3000.

Setting Up New Post

To add a new post to devoss.tech, it is recommended to first create an issue. Follow these steps:

  1. Go to the issues section of the devoss repository:

ISSUE

  1. Choose the ADD POST issue, and fill out the details as asked:

ADD POST

ISSUE FORM

  1. After creating the issue, you will be assigned to it, and then you can continue with the following steps to add your post.

  2. To set up a new post for contribution, devoss uses a Command Line Interface (CLI) to automate the entire process and make it easy for contributors.

  3. In order to create a new post, open a new terminal session in the devoss directory.

  4. In the new terminal session, run:

    npm run new-post

    This will prompt you with certain questions regarding your post. Something like this:

CONTRIBUTION CLI

  1. Once you have filled in all the prompts, your post file will be created in the /post directory. Your terminal should look like this:

CONTRIBUTION CLI

Finishing Up 🧹

Your post is now created in a markdown file under the /post directory. For example, if you gave your post the title of "Example Post For Devoss," your file will be /post/example-post-for-devoss.md`.

If you are using VSCode, I suggest using the shortcut CTRL + P to access your file.

The frontmatter of your markdown file is already managed by the responses given in the command line. You can change the frontmatter accordingly if needed.

This is how your file should look like:

POST INTRO

Now you can simply start adding the content of your post/guide. You can see the changes being reflected at localhost:3000.

Once you are done with the post setup, review everything, and you are good-to-go to make your contribution!

For more details on contribution, read the CONTRIBUTION GUIDELINES. Happy writing and contributing!