Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

85 lines (60 loc) · 2.53 KB

Contributing Guidelines

Thank you for your interest in contributing! 🎉
Whether you’re fixing a bug, adding a feature, or improving documentation, your help is appreciated.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top of the repository page to create your own copy.

  2. Clone Your Fork

    git clone https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git
cd REPOSITORY-NAME

  3. Create a Branch

    • Name your branch descriptively, e.g. fix/typo-in-readme or feature/add-login.
    git checkout -b branch-name

  4. Make Changes

    • Follow the coding standards described below.

  5. Test Your Changes

    • If applicable, run all tests to ensure your changes do not break existing code.

  6. Commit and Push

    git add .
git commit -m "Brief description of your changes"
git push origin branch-name

  7. Open a Pull Request (PR)

    • Go to your fork on GitHub and click "Compare & pull request".
    • Fill out the PR template and describe your changes.
    • Link related issues by typing Closes #issue_number.

Coding Standards

  • Code Style:

    • Use clear, descriptive names for variables and functions.
    • Write concise and meaningful commit messages.
    • Follow language-specific style guides (e.g., PEP8 for Python, Google JavaScript Style Guide, etc.).
    • Remove unused code and debug statements before submitting.

  • Documentation:

    • Document new functions/classes with docstrings or comments.
    • Update README.md or other relevant docs if your changes affect usage.

  • Testing:

    • Add or update tests for your changes if possible.
    • Ensure all tests pass before creating a PR.

Pull Request Review Process

  1. Automatic Checks

    • CI/CD will run tests and lints on your PR.
    • Make sure all checks pass.

  2. Review

    • A maintainer will review your PR for code quality, functionality, and adherence to guidelines.
    • You may be asked to make changes—please respond promptly.

  3. Merge

    • Once approved and all checks pass, your PR will be merged.
    • You’ll be credited in the project’s contributors list!

Need Help?

  • Open an issue describing your question or problem.
  • Use the Discussion tab for general questions or brainstorming.

📢 Join Official Slack channel for Discussion about the project : Code Script

Thank you for helping make this project better! 🚀