Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 3.28 KB

contribution.md

File metadata and controls

79 lines (49 loc) · 3.28 KB
Raw

Contribution Guidelines

Thank you for considering contributing to the AISKCON Construction project! We appreciate your support and collaboration. Please take a moment to review the guidelines below to ensure a smooth and efficient contribution process.

About AISKCON Construction

At AISKCON Construction, our mission is to assist people with their construction projects. We take pride in delivering high-quality work that meets the expectations of our customers. Our team comprises skilled professionals, including architects, engineers, and craftsmen, who collaborate to transform your ideas into reality. We possess expertise in handling various types of projects, whether it involves constructing homes, offices, or factories. Our services are diverse, catering to a wide range of requirements.

Techstack

The following technologies were utilized in building this website:

Front-End:

  • HTML
  • CSS
  • JavaScript

Back-End:

  • Node.js

Useful Extensions:

  • Prettier - Code formatter
  • ESLint

Project Initialization

To get started with contributing to the AISKCON Construction project, please follow the steps below:

  1. Download the Node.js package from nodejs.org.

  2. Fork the repository to your GitHub account.

  3. Clone the forked repository to your local machine using the following command:

    git clone https://github.com/<YOUR_GITHUB_USER_NAME>/AISKCON-CONSTRUCTION.git

  4. Install project dependencies by running the following command: npm install For Front-End development, open the index.html file and start the Live Server.

  5. For Back-End development, navigate to the backend directory using the following command: cd backend

  6. Start the server using the following command: npm start

Contribution Process

  1. To contribute to the AISKCON Construction project, please follow these steps:

  2. Create a new branch in your local repository to make your changes: git checkout -b <BRANCH_NAME> Implement your desired changes and improvements in the codebase.

  3. Commit your changes with a clear and descriptive commit message: git commit -m "Your commit message here"

  4. Push your changes to your forked repository on GitHub: git push origin <BRANCH_NAME>

  5. Open a pull request from your forked repository to the main AISKCON Construction repository.

  6. Provide a detailed description of your changes in the pull request, including any relevant information or context.

  7. Wait for the maintainers to review your pull request. They may provide feedback or request further changes before merging your contribution.

Code Guidelines

When contributing to the AISKCON Construction project, please adhere to the following code guidelines:

  • Follow the existing code style and formatting conventions.
  • Maintain consistency with the overall project structure and organization.
  • Write clear and concise code with appropriate comments where necessary.
  • Ensure your code is free from errors and runs without issues.

Conclusion

By following these contribution guidelines, you can actively contribute to the AISKCON Construction project and help us improve our services. Thank you for your dedication and support!

For any further questions or assistance, please reach out to the project maintainers or refer to the project's documentation.