Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 2.52 KB
Raw

Contributing to NexTrade 💹

We welcome contributions from the community! Whether you want to report an issue, contribute code, or improve documentation, we are happy to have your support. Please follow the guidelines below to make the contribution process as smooth as possible.

Getting Started

  1. Fork the repository: Click on the "Fork" button at the top right of this page to create your copy of the repository.

  2. Clone your fork:

    git clone "https://github.com/Akshat111111/NexTrade.git"
cd NexTrade

  3. Create a new branch: It's always good practice to create a new branch for your work.

    git checkout -b feature/your-feature-name

  4. Install dependencies:

    • Install required dependencies by running: 
      pip install -r requirements.txt
npm install
python run.py

Contributing Code

  1. Make changes: Implement your feature, bug fix, or other change in your branch.

  2. Lint and format your code: Ensure your code follows the project coding standards.

    npm run lint

  3. Test your changes: If applicable, make sure all tests pass:

    npm test

  4. Commit your changes: Use clear and descriptive commit messages.

    git add .
git commit -m "Add a descriptive message about your change"

  5. Push your branch:

    git push origin feature/your-feature-name

  6. Submit a pull request: Go to your fork on GitHub and create a pull request to merge your branch into the main repository.

Reporting Issues

If you find a bug, or want to request a new feature, please open an issue and include as much detail as possible. A good issue report includes:

  • A clear title
  • Steps to reproduce the issue (if applicable)
  • Expected behavior vs actual behavior
  • Screenshots, logs, or other helpful information

Code of Conduct

Please note that we have a Code of Conduct. By participating, you agree to adhere to its rules.

Additional Notes

  • Pull Request Reviews: Please be patient when waiting for reviews. Reviewers may request changes or improvements, so be prepared to make revisions if necessary.
  • Documentation: Contributions to documentation are highly appreciated! Please help keep the documentation up to date.
  • Communication: If you have any questions or need clarification, feel free to ask in the issue or pull request you opened.

Thank you for contributing to NexTrade!