Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

45 lines (39 loc) · 1.74 KB

Contribution Guidelines

  • Respectful Collaboration: Be respectful and constructive in your interactions.
  • Coding Standards: Use clear variable and function names.
  • Commit Messages: Write concise, clear, and meaningful commit messages.
  • Pull Requests: Submit small, focused pull requests that solve a single issue or add a single feature.

How to Contribute

We’re excited to have you contribute to this project! Follow these steps to get started:

  1. Fork the Repository
  • Navigate to the top of this repository and click the Fork button to create a copy of this repo in your GitHub account.
  1. Clone Your Forked Repository
  • Clone your fork to your local machine by running:
    git clone git@github.com:nisbweb/Code-Alchemy.git
  1. Create a New Branch
  • Create a new branch for your feature or bug fix:
    git checkout -b feature/your-feature-name

Keep your branch name descriptive of the feature or fix you’re working on. 4. Make Your Changes

  • Implement your changes or feature.
  1. Commit Your Changes
  • Once you’re satisfied with your changes, stage them:
    git add .
  • Commit the changes with a meaningful message:
    git commit -m "commit message"
  1. Push to GitHub
  • Push your branch to your forked repository:
    git push origin feature/your-feature-name
  1. Create a Pull Request
  • Go to the original repository on GitHub and click on Pull Requests.
  • Click the New Pull Request button.
  • Select your branch from the Compare dropdown and the original repository’s main branch in the Base dropdown.
  • Add a description of the changes and submit the pull request.
  1. Wait for Review
  • We will review your pull request.
  • Once approved, your changes will be merged into the main branch!