Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.61 KB
Raw

Contributing to Crypto Portfolio Tracker and Analyzer

We're thrilled you're considering contributing to our project! This document provides guidelines to help ensure a smooth contribution process for everyone involved. By participating in this project, you agree to abide by its terms.

Team Norms

Values

  • Collaboration: We work together, share ideas, and support each other.
  • Quality: We strive for excellence in every aspect of our project.
  • Inclusivity: We welcome contributors from all backgrounds and skill levels.
  • Transparency: We communicate openly about our progress and challenges.

Process

  • Regular team meetings to discuss progress and address issues.
  • Peer reviews to maintain code quality and foster learning.
  • Adherence to agreed-upon deadlines and milestones.

Git Workflow

  1. Fork the Repository: Start by forking the main repository to your GitHub account.
  2. Clone Your Fork: Clone your fork to your local machine for development.
  3. Create a Branch: For each new feature or fix, create a new branch based on main.
  4. Commit Changes: Make and commit your changes with clear, concise commit messages.
  5. Fetch Upstream: Regularly fetch changes from the upstream main branch to stay up-to-date.
  6. Rebase if Necessary: Rebase your branch on top of the upstream main if needed.
  7. Open a Pull Request: Once your changes are ready, open a pull request against the upstream main branch.
  8. Review and Revise: Address any comments or requests from the review process.

Contributing Rules

  • Code of Conduct: Adhere to the code of conduct outlined in CODE_OF_CONDUCT.md.
  • Pull Request Guidelines: Provide a clear description of the problem and solution, including any relevant issue numbers.
  • Style Guide Compliance: Ensure your code adheres to the project's style guidelines.
  • Testing: Add tests for new features and ensure they pass.

Setting Up Your Development Environment

  1. Prerequisites: Install Git, Node.js, and npm.
  2. Clone the repository:
git clone https://github.com/<your-fork>/4-final-project-crypto-portfolio-tracker.git
  1. Install Dependencies:
cd 4-final-project-crypto-portfolio-tracker
npm install

Building and Testing

Note: Detailed instructions will be provided as the project progresses.

To build the project:

Questions or Concerns?

Feel free to open an issue in the repository or reach out to the team directly via GitHub messages.

Thank you for contributing to Crypto Portfolio Tracker and Analyzer!