Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 2.2 KB

Contributing to NGX Bootstrap Components

We welcome contributions to the NGX Bootstrap Components library! Whether you're looking to fix bugs, add new features, or improve documentation, your help is appreciated. Here's how you can contribute:

Getting Started

  1. Fork the repository on GitHub.

  2. Clone your fork to your local machine for development.

    git clone https://github.com/YOUR_USERNAME/ngx-bootstrap-components.git
cd ngx-bootstrap-components

  3. Install dependencies to set up your development environment.

    npm install

Making Changes

  1. Create a new branch for your changes.

    git checkout -b your-feature-branch

  2. Make your changes in the codebase. Ensure you adhere to the existing coding style and follow Angular's best practices.

  3. Test your changes thoroughly. Add unit tests if applicable.

Submitting Changes

  1. Commit your changes. Write a clear, concise commit message that explains the purpose of your changes.

    git commit -am 'Add some feature'

  2. Push your changes to your fork.

    git push origin your-feature-branch

  3. Submit a pull request to the main repository. Provide a detailed description of your changes and reference any related issues.

Code Review

  1. Once your pull request is submitted, it will be reviewed by the maintainers. Be open to feedback and be prepared to make further improvements to your code.

  2. Address feedback from the review. You may need to make changes and update your pull request.

After Your Pull Request is Merged

Once your pull request is merged, you're officially a contributor! We encourage you to stay involved by:

  • Helping to review other pull requests.
  • Participating in discussions and providing feedback on the project.
  • Continuing to contribute with more pull requests!

Thank you for contributing to NGX Bootstrap Components. Your efforts help make this library better for everyone!

🧑‍💻 Community

Join our community on GitHub Discussions to connect with other contributors and discuss the future of the library.