Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

79 lines (57 loc) · 2.5 KB

Contribution Guidelines

Welcome to reactjs-accordion-ui package! We're thrilled that you'd like to contribute to our project. Before you get started, please take a moment to review our guidelines.

How Can You Contribute?

  1. Reporting Bugs:

    • If you encounter a bug, please open an issue and provide detailed information about the problem.

  2. Feature Requests:

    • Feel free to propose new features or improvements by opening an issue.

  3. Pull Requests:

    • Contributions are welcome! If you have a bug fix or a new feature, please submit a pull request.
    • Ensure that your code follows our coding standards and conventions.

Getting Started

  1. Fork the Repository:

    • Fork the reactjs-accordion-ui repository to your GitHub account.

  2. Clone the Repository:

    • Clone your forked repository to your local machine. 
      git clone https://github.com/SubramanyaKS/reactjs-accordion-ui.git

  3. Create a Branch:

    • Create a new branch for your contribution. 
      git checkout -b feature/your-feature

  4. Install Dependencies:

    • Navigate to the project directory and install the dependencies. 
      cd reactjs-accordion-ui
npm install

  5. Make Changes:

    • Make your changes, keeping in mind our coding standards.

  6. Run Tests:

    • Ensure that your changes pass existing tests and write new tests if necessary. 
      npm test

  7. Commit Changes:

    • Commit your changes with a descriptive commit message. 
      git commit -m "Your descriptive commit message"

  8. Push Changes:

    • Push your changes to your forked repository. 
      git push origin feature/your-feature

  9. Open a Pull Request:

    • Open a pull request from your branch to the main branch of the original repository.

  10. Code Review:

    • Your pull request will undergo code review. Make any necessary changes based on feedback.

  11. Merge:

    • Once your changes are approved, they will be merged into the main branch.

Thank You

Thank you for contributing to Reactjs-Accordion-UI! Your efforts help make our project better.

Happy Coding!