Skip to content

Commit ba2181f

Browse files
authored
Merge branch 'master' into readme/update-contributing-guidelines
2 parents 2c1a841 + 59bedb2 commit ba2181f

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,23 @@ yarn build
7878

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

81-
## Adding Content
81+
## Contributing
8282

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

85+
This is an open source project and contributions are what make an open source community.
86+
Everyone is welcome to contribute to this project.
87+
88+
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.
89+
90+
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.
91+
92+
Changes to `package-lock.json` and `yarn.lock` files should only be committed when:
93+
94+
- Adding a new dependency: Installing a new package will modify these lock files to ensure the exact version is documented.
95+
- Updating an existing dependency: Running an update for a package will adjust these files to reflect the new versions.
96+
- Removing a dependency: Uninstalling a package will update these files to remove the reference to the dependency.
97+
8598
### Add or Edit Feature Cards
8699

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

173186
![DarkTheme](screenshots/dark.png)
174187

175-
## Contributing
176-
177-
This is an open source project and contributions are what make an open source community.
178-
Everyone is welcome to contribute to this project.
179-
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.
180-
181-
First time contributors are welcome. Contributions can be very simple, make sure to check out beginner friendly issues, if present.
182-
183188
## Editing a Documentation File
184189
The PEcAn documentation is a crucial part of the project. We aim to make it comprehensive, accurate, and easy to navigate. When contributing to documentation, please keep the following in mind:
185190

0 commit comments

Comments
 (0)