CONTRIBUTING.md

Contributing to dgz-engineering

We are excited to have you as a contributor! Please follow the guidelines below to help us maintain a great project.

Setting Up the Development Environment

1. Clone the repository

   git clone https://github.com/gaviriaz/dgz-engineering.git
   cd dgz-engineering

2. Install Dependencies

   • Make sure you have the necessary tools installed, such as Node.js, npm, etc.
   • Run the following command to install dependencies:

     npm install

3. Run the Development Server

   • Start the development server:

     npm start

Submitting Pull Requests

1. Fork the repository on GitHub.
2. Create a feature branch from main:

   git checkout -b your-feature-name

3. Make your changes and commit them:

   git commit -m "Add some feature"

4. Push your changes:

   git push origin your-feature-name

5. Open a Pull Request on GitHub.

Code Standards

• Follow the Airbnb JavaScript Style Guide.
• Use meaningful names for variables and functions.
• Write clear and concise comments.

Testing Procedures

• Write tests for any new features or bug fixes.
• Ensure that all tests pass before submitting a pull request.
• To run tests, use:

  npm test

Thank you for your contributions!