Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.85 KB

👨‍💻 Contributing

1. Forking the Repo

A fork is a local copy of the repository that is on your GitHub account, and you can make changes on that repository.

Click here to fork the repository.

2. Creating a Post

You can create a post easily by making a new file in the src/content/posts directory.

For example, you could create the file hello.md. Now, you need to fill in the frontmatter of the post. This stores basic data about the post.

You can also supply image and slug to the frontmatter.

---
layout: ../../layouts/PostLayout.astro # Always use this layout, it's so the post gets properly styled
title: The title of the post
excerpt: A short description of the post
author: your-author-username
createdAt: Month Day, Year
---

**Post content goes here.**

3. Adding an Author

Go to src/util/authors.ts file. just extend the array by adding your desired username. Make sure it is in lowercase.

// Before:
export const AUTHORS = ["oyepriyansh", "william"] as const;

// After:
export const AUTHORS = ["oyepriyansh", "william", "your_desired_username"] as const;

4. Author Image

You can add an image for yourself by uploading an image to the /public/authors directory. Please make sure that is it spelt the exact same as your username in the src/util/authors.ts file.

Note: Capitalization does not matter for the image file, but still make it all lowercase.

5. Pull Request

  • You can now commit changes to the DevTweet repository. Once you've made the changes you want, create a pull request. Make sure to add a good PR title, example: feat: add post by johndoe.
  • Once you have submitted your pull request, it will be reviewed and merged as soon as possible.