Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (59 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

99 lines (59 loc) · 2.8 KB
Raw

@sse-auth/react package

Thank you for considering contributing to the @sse-auth/react package! We appreciate your interest in helping us improve this project.

Getting Started

Before you start contributing, please make sure you have:

  • Node.js (version 14 or higher) installed on your machine
  • A GitHub account
  • A basic understanding of React and JavaScript

Types of Contributions

We welcome the following types of contributions:

  • Bug fixes: Fixing issues reported in the issue tracker
  • New features: Adding new functionality to the package
  • Documentation improvements: Enhancing the documentation to make it more accurate and helpful
  • Code refactoring: Improving the code structure and organization

Step-by-Step Contribution Guide

1. Fork the Repository

Fork the @sse-auth/react repository on GitHub to create a copy of the repository in your own account.

2. Clone the Repository

Clone the forked repository to your local machine using the following command:

git clone https://github.com/sse-auth/react.git

3. Install Dependencies

Install the dependencies required by the package using the following command:

npm install

4. Create a New Branch

Create a new branch for your contribution using the following command:

git checkout -b your-branch-name

5. Make Changes

Make the necessary changes to the code, documentation, or tests. Please make sure to follow the existing coding style and conventions.

6. Commit Changes

Commit your changes using the following command:

git commit -m "your-commit-message"

7. Push Changes

Push your changes to your forked repository using the following command:

git push origin your-branch-name

8. Create a Pull Request

Create a pull request to the @sse-auth/react repository, targeting the master branch.

Pull Request Guidelines

When creating a pull request, please make sure to:

  • Provide a clear and concise title and description
  • Include relevant screenshots or examples
  • Mention any related issues or pull requests
  • Follow the existing coding style and conventions

Code Review

Our team will review your pull request and provide feedback. Please be patient and responsive to our comments and suggestions.

License

By contributing to the @sse-auth/react package, you agree to license your contributions under the MIT License.

Acknowledgments

We appreciate your contributions to the @sse-auth/react package! Your efforts help us improve the package and make it more useful for the community.

If you have any questions or need help with the contribution process, please don't hesitate to reach out to us.

Feel free to copy and use this markdown content for your GitHub repository! If you need any modifications or additional sections, let me know.