Skip to content

Latest commit

 

History

History
118 lines (73 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

118 lines (73 loc) · 3.1 KB
Raw

Contributing to Angular RSocket Service Library

Thank you for considering contributing to the Angular RSocket Service Library! We welcome all types of contributions including bug fixes, new features, documentation improvements, and more. This guide will help you get started.

How to Contribute

1. Reporting Issues

If you encounter any bugs, or have suggestions for improvements or new features, please open an issue in the GitHub repository.

When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the issue and how to reproduce it.
  • The expected and actual behavior.
  • Information about your environment (Angular version, browser, etc.).
  • Any relevant error messages or logs.

2. Contributing Code

We encourage you to submit bug fixes, features, and improvements. Here’s how you can contribute code:

2.1 Fork the Repository

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/saleweaver/angular-rsocket.git

  3. Navigate to the project directory:

    cd angular-rsocket

2.2 Set Up the Development Environment

  1. Install the dependencies:

    npm install

  2. Make sure all tests pass before making any changes:

    npm test

2.3 Make Your Changes

  • Create a new branch for your changes:

    git checkout -b feature/your-feature-name

  • Make your changes in the codebase, and ensure that the new code is well-tested.

  • Run the tests to ensure your changes don't break anything:

    npm test

2.4 Commit Your Changes

  • Format your commit messages following best practices:

    git commit -m "feat: describe the feature or fix"

  • Push your changes to your forked repository:

    git push origin feature/your-feature-name

2.5 Submit a Pull Request

  1. Go to the original repository and open a new pull request.
  2. Make sure to reference any relevant issues in your pull request description.
  3. Ensure that your pull request passes all checks (e.g., automated tests, linting).
  4. Wait for feedback from the maintainers.

3. Writing Documentation

Contributions to the documentation are highly appreciated! If you find any areas of the documentation that can be improved or clarified, feel free to submit a pull request.

When updating the documentation:

  • Ensure that the examples are up-to-date.
  • Clarify any confusing areas and add relevant explanations.

4. Code Style

Please follow the existing coding style of the project. The project uses TypeScript and standard Angular coding conventions. You can use the following command to automatically format your code:

npm run format

5. Code of Conduct

Please note that we have a Code of Conduct in place. By participating, you are expected to uphold this code.

Need Help?

If you need help with anything related to the project, feel free to reach out by opening an issue. We will do our best to help you.

Thank you for contributing!