Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (42 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.79 KB

Contributing to GitConfig Pro

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions!

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you've found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

I Want To Contribute

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as many relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Ensure the enhancement was not already suggested by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the enhancement, open a new one.

Your First Code Contribution

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine.
  3. Create a branch for your feature or bug fix.
  4. Edit the files and commit your changes.
  5. Push your branch to your fork.
  6. Submit a Pull Request to our main branch.

Setup Local Environment

  1. Make sure you have Node.js installed.
  2. Install dependencies: 
    npm install
# or
pnpm install
# or
yarn install
  3. Run the development server: 
    npm run dev

Adding New Technologies

See the README.md section on How to Add New Features > Adding a New Technology Template for a step-by-step guide.