CONTRIBUTING.md

Contributing to Code Scope - AI-powered code analysis. Analyse your code and unlock its potential.

🎉🚀🙌🏻 First off, thanks for taking the time to contribute! 🙌🏻🚀🎉

First off, thank you for considering contributing to this repository. It's people like you that make Open Source so great.

Please read our guidelines before you start.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Contributions we are looking for.

We keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that mean less work for you.

Ground Rules

Follow our Code of Conduct.

We expect everyone to abide by our Code of Conduct. Please read it. 🤝

Your First Contribution

Here are a couple of friendly tutorials to help you get started: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Getting started

Prerequisites

You will need at least node.

• Download Node Here

In this repo we favour npm as the "official" package manager.

Run the project

1 - Create a local.env file in the root directory of the project and add your OpenAI API key as follows (or go to ai/index.ts and use the mock)

OPENAI_API_KEY=YOUR_API_KEY_HERE

2 - Install dependencies

npm i

3 - Run the project in development mode.

npm run dev

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

Open an issue using the BUG template provided.

How to suggest a feature or enhancement

Open an issue using the FEATURE template provided.

Code review process

For your contribution to get accepted after it’s been submitted.

Your contribution will have to be Approved by a member of the Core Team before being merged.

The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Code, commit message and labeling conventions

Commit message conventions.

We do not yed decided on this so for now use your common sense

Code Style Enforced by Prettier

Prettier guarantees the code style adopted and runs on commit, stick to this code style.

Prettier site for more information

PULL Requests

Opening pull requests should be done using the github template, with enough information and screenshots for visual changes to facilitate the reviewers job. Its MANDATORY to add a link to the issue related