Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 3.89 KB

CONTRIBUTING.MD

File metadata and controls

118 lines (83 loc) · 3.89 KB

Contributing to [DSA-with-JavaScript]

We welcome contributions to the [DSA-with-JavaScript] project! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.

Table of Contents

How to Contribute

  1. Fork the Repository:

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

  2. Clone Your Fork:

    • Clone your fork to your local machine using the following command: 
      git clone https://github.com/annuk123/DSA-with-JavaScript.git

  3. Create a New Branch:

    • Create a new branch for your changes: 
      git checkout -b your-feature-branch

  4. Make Changes:

    • Make your changes in your local branch. Ensure you follow the coding guidelines and conventions used in the repository.

  5. Write Tests:

    • Add tests for any new features or bug fixes. Ensure that all tests pass before submitting your changes.

  6. Commit Your Changes:

    • Commit your changes with a clear and descriptive message: 
      git add .
git commit -m "Add a brief description of the changes"

  7. Push Your Changes:

    • Push your changes to your fork: 
      git push origin your-feature-branch

  8. Create a Pull Request:

    • Go to the repository on GitHub and click the "New Pull Request" button.
    • Select your branch and describe the changes you made. Include relevant details and any additional information that will help reviewers understand your contribution.

Organizing Content

  1. Question Format:

    • Title: A brief description of the problem.
    • Description: Detailed explanation of the problem and any constraints.
    • Examples: Input and output examples.
    • Instructions: Any specific instructions or requirements.

    Example:

    Title: Reverse a String

    Description: Write a function that takes a string as input and returns the string reversed.

    Examples:

    • Input: "hello"
    • Output: "olleh"

    Instructions:

    • Implement the function reverseString(str) where str is the input string.

  2. Solution Format:

    • Title: Reference to the question.
    • Solution: The code solution.
    • Explanation: Brief explanation of the solution approach.

    Example:

    Solution for: Reverse a String

    Solution:

    function reverseString(str) {
    return str.split('').reverse().join('');
}

    Explanation:

    • The function splits the string into an array of characters, reverses the array, and then joins the characters back into a string.

Reporting Issues

If you find a bug or have a feature request, please report it by opening an issue. Provide as much detail as possible to help us address the issue efficiently.

Submitting a Pull Request

When submitting a pull request, please follow these guidelines:

  • Provide a clear and concise title and description for your pull request.
  • Ensure that your pull request addresses a single issue or feature.
  • Link to any related issues in your pull request description.
  • Follow the project's code style and guidelines.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We strive to create a welcoming and inclusive environment for all contributors.

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to [DSA-with-JavaScript]!

For any additional questions or guidance, feel free to reach out to the project maintainers.