Skip to content

Commit

Permalink
Update guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgiakatos committed Nov 8, 2024
1 parent 5c6df4d commit 1590ec1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,14 @@ Our website uses the following libraries:
- [vue-i18n](https://www.npmjs.com/package/vue-i18n): This is an internationalization plugin for Vue.js
- [vue-router](https://www.npmjs.com/package/vue-router): Vue Router is the official routing library for Vue.js

## Code Lint

It's important to check your code for potential errors and adherence to coding standards. You can do this by running the linter with the following command:

```bash
npm run lint
```

## Code Style

Before push your contribution, ensure that your code is properly formatted. You can automatically
Expand Down Expand Up @@ -137,6 +145,7 @@ pull request or create an issue.
├── SECURITY.md: A document detailing the security practices of the project, including how to report vulnerabilities and security issues
├── babel.config.cjs: Configuration file for Babel, a JavaScript compiler, specifying how to transform modern JavaScript code into a backward-compatible version
├── default.conf: Nginx configuration file, specifying settings such as ports, routes, and other parameters
├── eslint.config.cjs: Configuration file for ESLint
├── index.html: The main HTML file that serves as the entry point for the web application, containing the structure and layout of the webpage
├── package.json: A file that contains metadata about the project, including dependencies, scripts, and project configuration for Node.js applications
├── public
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ cd ihr-website
Note:
- you can use [nvm](https://github.com/nvm-sh/nvm) to switch between node versions as per your need

Install all the npm packages. Go to root directory and type the following command to install all npm packages
#### Install all the npm packages.

```bash
npm install
```


For compilations and hot-reloads in development
#### For compilations and hot-reloads in development

```bash
npm run dev
Expand All @@ -50,6 +50,12 @@ npm run build
npm run lint
```

#### To format files

```bash
npm run format
```

## Deploy with Docker

To deploy the project with Docker, follow these steps:
Expand Down Expand Up @@ -79,10 +85,11 @@ Replace `<host-port>` with the port on your host machine where you want to expos

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

When contributing to this repository, please first discuss the change you wish to make via issue with the maintainers of this repository before making a change. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Before you start, please follow these guidelines:

1. Solve the issues which are listed
2. Create your own issue and then send PR.
1. **Solve Existing Issues**: If you find an existing issue that you would like to work on, please discuss it with the maintainers before starting to solve it. This ensures that everyone is on the same page regarding the approach and scope of the solution.
2. **Create a New Issue**: If you have an idea for a new feature or have identified a bug that is not listed, please discuss it with the maintainers before creating a new issue. Providing context and details will help us understand the importance of your suggestion.
3. **Pull Requests (PRs)**: Please note that PRs that are not assigned to contributors and are not related to an open issue will be closed automatically.

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow. The basic workflow:

Expand Down

0 comments on commit 1590ec1

Please sign in to comment.