Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 3.41 KB

Contribution Guidelines

Welcome to the csv-firestore repository! We're excited to have you contribute to organizing and standardizing structured methods for efficiently uploading CSV files to the Firestore database. To ensure a smooth contribution process for everyone, please follow these guidelines.

Getting Started

  1. Fork the Repository: Start by forking the repository's "dev" branch to your GitHub account. This creates your own copy of the project where you can make changes.

  2. Clone Your Fork: Clone your forked repository to your local machine using Git. This allows you to work on the files locally.

    git clone https://github.com/yourusername/csv-firestore.git

  3. Set Upstream Remote: Add the original repository as an upstream remote to your local clone. This helps you to keep your fork up to date.

    git remote add upstream https://github.com/ciatph/csv-firestore.git

Making Changes

  1. Create a New Branch: Always work on a new branch for your changes. This keeps your contributions organized and separate from the main branch.

    git checkout -b feat/your-new-feature-name

  2. Add Your Content: Make your changes or additions to the project. If you're adding new content, ensure it's placed in the correct directory and follows intuitive naming conventions and JavaScript coding best practices and patterns for Node.

  3. Commit Your Changes: After making your changes, commit them to your branch. Use clear and concise commit messages to describe your updates.

    git add .
git commit -m "Add a brief description of your changes"

  4. Keep Your Fork Updated: Regularly sync your fork's "dev" branch with the upstream repository to keep it up to date. This reduces potential merge conflicts.

    git fetch upstream
git checkout dev
git merge upstream/dev
git push origin dev

Submitting Contributions

  1. Push Your Changes: Push your changes to your fork on GitHub.

    git push origin feat/your-new-feature-name

  2. Create a Pull Request (PR): Go to the original csv-firestore repository on GitHub and create a new pull request. Base your PR on your feature branch and target the "dev" branch of the upstream repository.

  3. Describe Your Contribution: Provide a clear and detailed description of your pull request. Include the purpose of your changes and any other relevant information.

  4. Review and Collaboration: Once your PR is submitted, the project maintainers will review your contributions. Be open to feedback and ready to make additional changes if requested.

Guidelines

  1. Quality: Ensure your contributions are high quality, with no spelling or grammatical errors.

  2. Relevance: Content should be relevant to mostly JavaScript method updates and code documentation for users and devs interested in using a simple and organized library for quickly uploading CSV files to Firestore.

  3. Respect: Respect the structure and formatting of the existing project. Follow the standard ESLint rules defined in its eslintrc.js file. Use JavaScript classes or modules where appropriate.

Thank you for contributing to the csv-firestore repository. Your efforts help make our Firestore community more organized with CSV data uploading.

Credits

Contributing Guidelines inspired by the DataEngineeringPilipinas Contributing guide.