Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 3.43 KB
Raw

Contributing to ngx-primer

Thank you for your interest in contributing to ngx-primer! Whether you're reporting a bug, suggesting an enhancement, or submitting a pull request, we appreciate your contributions.

How to Contribute

Reporting Bugs

If you encounter a bug, please search the issue tracker to see if it's already been reported. If not, open a new issue with the following information:

  • A clear description of the bug
  • Steps to reproduce the issue
  • Expected and actual behavior
  • The version of ngx-primer you are using
  • Any relevant error messages or stack traces

Suggesting Enhancements

We are open to suggestions for new features or improvements! If you have an idea, please check the issue tracker first to see if it’s already been discussed. If not, feel free to create a new issue with:

  • A clear description of the enhancement
  • The use case for the enhancement
  • Any potential challenges or implementation ideas you have in mind

Submitting a Pull Request (PR)

We welcome pull requests for new features, bug fixes, and documentation improvements. To submit a PR, please follow these steps:

  1. Fork the repository: Click the "Fork" button at the top of the repository to create a copy of the project under your own GitHub account.
  2. Clone your fork: Clone your fork to your local machine. 
    git clone https://github.com/your-username/ngx-primer.git
  3. Create a new branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement your feature or bug fix. Ensure that your code follows the project's coding style and conventions.
  5. Run tests: Run the tests to make sure everything works as expected. 
    nx test ngx-primer
  6. Commit your changes: Commit your changes with a clear message describing what you've done. 
    git commit -m "Add new feature or fix bug"
  7. Push your changes: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  8. Create a pull request: Open a pull request against the main repository's main branch. Provide a clear description of your changes, including any relevant context or linked issues.

Code Style and Guidelines

  • Follow the existing code style of the project.
  • Use descriptive commit messages.
  • Add unit tests for new features or bug fixes whenever possible.
  • If your changes are related to a specific component, make sure to update the documentation accordingly.

Code of Conduct

By participating in this project, you agree to follow our Code of Conduct. We want to maintain a friendly and inclusive environment for all contributors, so please be respectful and considerate.

Communication

If you have any questions or need clarification on something, feel free to ask for help. You can reach us through the following channels:

Licensing

By contributing to this project, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for contributing to ngx-primer! We look forward to your contributions and working together to improve the project.