Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (30 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.7 KB

Contributing to @nodesandbox/async-storage

We welcome contributions to the @nodesandbox/async-storage project! To make the contribution process smooth and efficient, please follow the guidelines outlined below.

How to Contribute

  1. Fork the Repository: Start by forking the repository on GitHub. This creates a copy of the project under your GitHub account.

  2. Clone the Fork: Clone your forked repository to your local machine:

    git clone https://github.com/your-username/async-storage.git

  3. Create a New Branch: Create a new branch for your feature or bug fix:

    git checkout -b my-feature-branch

  4. Make Changes: Implement your feature or bug fix. Make sure to test your changes thoroughly.

  5. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "Add feature or fix description"

  6. Push to Your Fork: Push your changes to your forked repository:

    git push origin my-feature-branch

  7. Create a Pull Request: Navigate to the original repository and create a pull request from your forked branch.

Code Standards

  • Follow the existing coding style and conventions used in the project.
  • Ensure that your code is clean and well-documented.
  • Write tests for your changes where applicable.

Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Be sure to provide as much detail as possible to help us understand the problem or suggestion.

Thank You!

Thank you for considering contributing to @nodesandbox/async-storage. Your contributions help us improve and enhance the project for everyone!