Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

80 lines (62 loc) · 3.07 KB
Raw

Contributing to Dev-Blogs

Welcome, and thank you for considering contributing to Dev-Blogs! 🙌 We're excited to have you collaborate with us to build and improve this open-source project. Below are the guidelines to help you get started.

How Can You Contribute?

We welcome contributions of all kinds, including but not limited to:

  • Adding Blog Posts: Submit a technical blog post related to development, technology, or open-source.
  • Fixing Bugs: Find and fix bugs or issues within the project.
  • Suggesting New Features: Have a new feature in mind? Propose it or help implement it.
  • Improving Documentation: Help us maintain up-to-date and accurate documentation.

Step-by-Step Guide to Contributing

1. Fork the Repository

To make contributions, you'll first need to fork the repository:

  1. Navigate to the Dev-Blogs repository.
  2. Click the Fork button at the top-right corner to create a copy of the repository under your GitHub account.

2. Clone Your Fork

Once you've forked the repository, clone it to your local machine using the following command:

git clone https://github.com/Snakes-n-Networks/Dev-blogs

This will create a local copy of the project on your machine.

3. Create a New Branch

Always work on a separate branch for your changes:

git checkout -b my-feature-branch

Name your branch appropriately based on the changes you're making, e.g., add-blog-post, fix-bug, improve-docs.

4. Make Changes

  • For Blog Posts:

    • Add your blog in the appropriate directory (e.g., /content/blogs/).
    • Blog posts should follow our markdown structure and guidelines outlined in the Blogging Guidelines.
    • Include images or links if needed and ensure your blog post is formatted correctly.

  • For Code Contributions:

    • Make sure you follow the project’s coding standards.
    • Ensure your changes are functional and, if possible, write tests to accompany your code.

5. Test Your Changes

Before submitting, test your changes locally to ensure they work as expected. For blog posts, you can preview the website:

npm install
npm run dev

This will start the local development server.

6. Commit Your Changes

After verifying your changes, stage the modified files and commit them:

git add .
git commit -m "Add: Description of changes"
  • Use concise and descriptive commit messages (e.g., Fix: Bug in navigation menu or Add: New blog post on JavaScript basics).

7. Push Your Changes

Push your changes to your forked repository on GitHub:

git push origin my-feature-branch

8. Submit a Pull Request (PR)

Once your changes are pushed, go to the original Dev-Blogs repository and submit a pull request (PR):

  1. Go to the Pull Requests tab.
  2. Click New Pull Request.
  3. Choose the branch with your changes and submit the PR.
  4. In the PR description, clearly explain the changes you’ve made and why they are beneficial.

Your pull request will then be reviewed by maintainers, and feedback may be provided.