Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

117 lines (89 loc) · 4.16 KB

Contributing to RuneScript

We’re thrilled that you want to contribute to RuneScript! By contributing, you’ll help make this project better for developers, creators, and the wider tech community. This guide will walk you through how to contribute effectively.

Table of Contents

  1. Introduction
  2. How to Create and Submit Pull Requests
  3. Adding New Features or Files
  4. GitHub Workflow Overview
  5. Opening Issues
  6. Get in Touch

Introduction

To get started with contributing, follow these steps:

  1. Fork the Repository: Click the 'Fork' button at the top-right corner of this repository to create your own copy.
  2. Clone Your Fork: Clone your forked repository to your local machine using the command: 
    git clone https://github.com/your-username/RuneScript.git
  3. Navigate to the Project Directory: Move to the project directory: 
    cd RuneScript

How to Create and Submit Pull Requests

Step-by-Step Guide for Pull Requests

  1. Create a New Branch:
    • Always create a new branch for each feature or bug fix to keep your main branch clean.
    git checkout -b your-branch-name
  2. Make Your Changes:
    • Add or modify files as needed for your contribution.
  3. Stage Your Changes:
    • Stage the files you’ve modified:
    git add .
  4. Commit Your Changes:
    • Write a clear and descriptive commit message:
    git commit -m "Brief description of your changes"
  5. Push Your Changes to GitHub:
    • Push your branch to your forked repository:
    git push origin your-branch-name
  6. Open a Pull Request:
    • Navigate to the original repository and you’ll see a button to create a pull request. Follow the instructions to submit your PR for review.

Adding New Features or Files

File Naming Guidelines

When creating new files, use descriptive names that clearly explain their purpose. For features that involve multiple files, organize them in a new folder.

  • Scripts: Use camelCase for script files. 
    exampleFeatureScript.py
  • Posts or Logs: Use the format YYYY-MM-DD-title.md for markdown files. 
    2024-12-01-new-ai-integration.md

Place these files in their respective directories (e.g., src/scripts, docs/posts).

GitHub Workflow Overview

Classic Workflow

  1. Fork the Repository: Create a copy of the repository under your GitHub account.
  2. Clone Your Fork: Download your forked repository to your local machine.
  3. Create a Branch: Always create a new branch to work on a specific feature or fix.
  4. Make Changes: Add, edit, or remove files as needed.
  5. Commit Your Work: Save your changes with clear commit messages.
  6. Push Your Changes: Upload your branch to GitHub.
  7. Submit a Pull Request: Propose your changes for review and inclusion in the main repository.

Opening Issues

Found a bug? Have a suggestion for a feature? Open an issue to share it with us!

  1. Go to the Issues Tab: Visit the Issues tab in this repository.
  2. Click "New Issue": Use the 'New Issue' button to start.
  3. Describe the Issue:
    • Bug: Include steps to reproduce, expected behavior, and screenshots if possible.
    • Feature Request: Explain your idea and why it would be useful.
  4. Submit the Issue: Click 'Submit new issue' to post.

Get in Touch

Have questions or ideas beyond what’s in the Issues tab? Reach out to us via:

  • GitHub Discussions: Engage with the community here.
  • Email: For specific queries, contact us at axlffcc@gmail.com.

Thank you for contributing to RuneScript! Together, we’re building a tool that empowers creativity, collaboration, and innovation. Let’s make something amazing. 🚀