Skip to content

Provide guidance on package-lock.json and yarn.lock #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Provide guidance on package-lock.json and yarn.lock #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,23 @@ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Adding Content
## Contributing

This describes how to add or modify the Website's content.

This is an open source project and contributions are what make an open source community.
Everyone is welcome to contribute to this project.

All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/master/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment.

First time contributors are welcome. Contributions can be very simple, make sure to check out issues labeled ['good first issue'](https://github.com/PecanProject/PecanProject.github.io/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). If you have an idea, the best place to start a discussion is on the PEcAn project Slack channel, or by opening an issue in this repository.

Changes to `package-lock.json` and `yarn.lock` files should only be committed when:

- Adding a new dependency: Installing a new package will modify these lock files to ensure the exact version is documented.
- Updating an existing dependency: Running an update for a package will adjust these files to reflect the new versions.
- Removing a dependency: Uninstalling a package will update these files to remove the reference to the dependency.

### Add or Edit Feature Cards

Feature Cards on the website homepage highlight the key features of the PEcAn Project.
Expand Down Expand Up @@ -172,14 +185,6 @@ This section contains screenshots of website's homepage in light and dark theme.

![DarkTheme](screenshots/dark.png)

## Contributing

This is an open source project and contributions are what make an open source community.
Everyone is welcome to contribute to this project.
All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/master/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment.

First time contributors are welcome. Contributions can be very simple, make sure to check out beginner friendly issues, if present.

## Next Steps

This section contains future plans for the website. New contributors can use this section as a reference for planning their contributions.
Expand Down
Loading