Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 4.02 KB

CONTRIBUTING.md

File metadata and controls

122 lines (87 loc) · 4.02 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our "@bitfiber/ng" library! We welcome contributions from the community to help improve and expand the functionality of our library. By contributing, you can help make our library more useful for developers across different projects and domains.

Code of Conduct

Before getting started, please review our Code of Conduct to understand the behavior that is expected of all contributors.

Getting Started

To contribute to our "@bitfiber/ng" library, follow these steps:

  1. Fork the GitHub Repository to your own GitHub account.

  2. Clone the forked repository to your local machine.

  3. Create a new branch, see guide.
    Branch naming conventions:

  • For features: feature/<your-feature-branch-name>
  • For bug fixes: fix/<your-bugfix-branch-name>.
  • For tests: tests/<your-tests-branch-name>.
  • For docs: docs/<your-docs-branch-name>.
  • For refactoring: refactor/<your-refactoring-branch-name>
  • For performance improving: perf/<your-performance-branch-name>

  1. Switch to the newly created branch.

  2. Go into repository folder by running:

    cd ng

  3. Install Node.js using nvm:
    <version> - take the Node.js version from Angular node versions considering Angular version in package.json

    nvm install <version>
nvm use <version>

  4. Install @angular/cli globally:
    <version> - version as in package.json

    npm install -g @angular/cli@<version>

  5. Install dependencies by running:

    npm install

  6. Make your changes, following the guidelines and best practices outlined below.

  7. Run tests to ensure that your changes haven't introduced any regressions by running:

    ng test ng

  8. Ensure your code adheres to the style guidelines by running ESLint:

    ng lint ng

    or

    ng lint ng --quiet

  9. Push your changes to your forked repository.

  10. Submit a pull request (PR) to the repository`s main branch, explaining the purpose and scope of your changes.

Guidelines and Best Practices

To ensure that your contributions are accepted and integrated smoothly, please adhere to the following guidelines and best practices:

  • Follow the Style Guide: Maintain consistency with the existing codebase by following our eslint coding style.

  • Write Tests: Ensure that your changes are covered by tests. Write unit tests for new functionality and update existing tests for changes to ensure full test coverage.

  • Document Changes: Provide clear and concise documentation for any new functionality or changes made to existing functionality. This includes updating README.md, adding JSDoc comments, and any other relevant documentation.

  • Keep PRs Small and Focused: Submit separate PRs for each logical change or set of related changes. This makes it easier to review and merge your contributions.

  • Be Responsive: Be responsive to feedback and comments on your PRs. Address any review comments promptly and make necessary adjustments to your code.

  • Respect Licensing: Ensure that your contributions adhere to the licensing terms of the project. If you're introducing dependencies with different licenses, make sure they are compatible with our project's license.

Need Help?

If you need any assistance or have questions about contributing, feel free to reach out to us via our community discussion forum. We're here to help!

Thank you for your interest in contributing to our "@bitfiber/ng" library. We appreciate your support and look forward to your contributions!