Skip to content

contribution.md

Latest commit

 

History

History
80 lines (61 loc) · 2.84 KB

contribution.md

File metadata and controls

80 lines (61 loc) · 2.84 KB

Contribution Guidelines

Thank you for considering contributing to this project! Here are some guidelines to help you get started.

Table of Contents

  1. How to Report Issues
  2. How to Submit a Pull Request
  3. Coding Standards
  4. Code of Conduct
  5. Getting Started
  6. Community

How to Report Issues

If you find a bug or have a feature request, please create an issue on the GitHub Issues page. Provide as much detail as possible to help us understand and address the issue. Include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual results.
  • Screenshots or code snippets, if applicable.
  • Any other relevant information.

How to Submit a Pull Request

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page.
  2. Clone your fork: 
    git clone https://github.com/Ayushjhawar8/Sorting-Visualiser.git
cd your-repo
  3. Create a new branch: 
    git checkout -b feature-or-bugfix-name
  4. Make your changes: Ensure your code follows the coding standards outlined below.
  5. Commit your changes: 
    git add .
git commit -m "Descriptive commit message"
  6. Push your branch: 
    git push origin feature-or-bugfix-name
  7. Create a pull request: Go to the original repository and click the "New Pull Request" button. Select your branch and provide a clear description of your changes.

Coding Standards

  • Code Style: Follow the existing code style and conventions.
  • Commit Messages: Write clear and concise commit messages.
  • Documentation: Ensure your code is well-documented with comments and, if applicable, update the project documentation.
  • Testing: Write tests for any new functionality and ensure all tests pass before submitting a pull request.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms. Be respectful and considerate in your interactions with others.

Getting Started

To get started with the project, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/your-username/Sorting-Visualiser.git
cd your-repo
  2. Open the project in your preferred code editor.
  3. Run the project: Open index.html in your web browser.
  4. Start: Start live server

Community

Join our community to stay updated and get help:

Thank you for your contributions!