Skip to content

Commit

Permalink
Added rules for tests and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sherwin-14 committed Sep 21, 2024
1 parent 5bc563c commit 67deb38
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,13 @@

- Added example PR links to pull request template
([#756](https://github.com/nsidc/earthaccess/issues/756))
[**@Sherwin-14**](https://github.com/betolink),
[**@Sherwin-14**](https://github.com/Sherwin-14),
[**@mfisher87**](https://github.com/mfisher87)


- Added Contributing Naming Convention document
([#532](https://github.com/nsidc/earthaccess/issues/532))
[**@Sherwin-14**](https://github.com/Sherwin-14),
[**@mfisher87**](https://github.com/mfisher87)

### Fixed

Expand Down
15 changes: 9 additions & 6 deletions docs/contributing/naming-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,26 @@

## General Guidelines

1.This document outlines the naming conventions for our project.
2.These conventions are intended to promote consistency and clarity across different components.
This document outlines the naming conventions for our project. These conventions are intended to promote consistency and clarity across different components.

### Specific Conventions

#### Python Code

Style: We follow the official Python Enhancement Proposal 8 (PEP8) guidelines for naming conventions.
**Style**: We follow the official Python Enhancement Proposal 8 [PEP8]((https://peps.python.org/pep-0008/#package-and-module-names) ) guidelines for naming conventions.

#### Jupyter Notebooks

File Names: File names should start with an underscore (_). Please use underscores instead of hyphens.
**File Names**: File names should start with an underscore (_). Please use underscores instead of hyphens.

#### Documentation

**Directory and File Names**: Directory and file names should use hyphens (-) instead of underscores.

#### Tests

1. **Test File and Function Names**: Test files and functions should start with `test_`.
2. **Additional Guidelines**: For additional guidelines, please refer to the [pytest documentation](https://docs.pytest.org/en/stable/explanation/goodpractices.html#conventions-for-python-test-discovery).



!!! note "Test File Naming Convention"
We do not use the _test.py suffix for test files
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ nav:
- "Our meet-ups": "contributing/our-meet-ups.md"
- "Maintainers Guide": "contributing/maintainers-guide.md"
- "Code of Conduct": "contributing/code-of-conduct.md"
- "Naming Convention": "contributing/naming-convention.md"
- "Resources": "resources.md"
- USER GUIDE:
- "user_guide/index.md"
Expand Down

0 comments on commit 67deb38

Please sign in to comment.