Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 2.53 KB
Raw

Contributing to Stocks API

Thank you for considering contributing to the Stocks API! This project is built using Node.js and Express.js, offering a simple yet powerful interface for retrieving stock data from various sources. Whether you're building a financial app, conducting research, or simply curious about stock prices, this API has you covered.

How to Contribute

We welcome contributions from everyone, regardless of your level of expertise. Here are a few ways you can contribute to improving the Stocks API:

  • Report Bugs: If you encounter any bugs while using the API, please open an issue on GitHub. Be sure to include as much detail as possible, including steps to reproduce the issue.
  • Request Features: If you have ideas for new features or improvements to existing ones, feel free to open an issue to discuss them.
  • Submit Pull Requests: If you're a developer, you can contribute directly by submitting pull requests. Before starting work on a pull request, please make sure to open an issue to discuss the proposed changes.

Getting Started

To get started with contributing to the Stocks API, follow these steps:

  • Fork the Repository: Click the "Fork" button in the top-right corner of the GitHub repository to create your own copy of the project.
  • Clone the Repository: Clone your fork of the repository to your local machine using the command: 
    git clone https://github.com/prashasth-nair/Stocks-API.git
  • Install Dependencies: Navigate to the project directory and install the necessary dependencies using npm: 
    cd Stocks-API
npm install
  • Make Changes: Make your desired changes to the codebase.
  • Test Your Changes: Before submitting a pull request, make sure to test your changes thoroughly to ensure they don't introduce any new issues.
  • Submit a Pull Request: Once you're happy with your changes, push them to your fork and submit a pull request. Be sure to provide a clear description of the changes you've made and reference any related issues.

Code Style Guidelines

To maintain consistency and readability in the codebase, please follow these guidelines when contributing:

  • Use consistent indentation (preferably two or four spaces).

  • Follow the naming conventions used throughout the codebase.

  • Write clear and concise comments to explain complex or non-obvious code.

  • Write descriptive commit messages that explain the purpose of each commit.

    Thank you for your interest in contributing to the Stocks API! We appreciate your support in making this project even better.