Skip to content

Commit

Permalink
Made the discusssed changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Sherwin-14 committed Jun 24, 2024
1 parent c06693d commit b4d27f7
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions docs/maintainers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,24 @@

This page offers guidance to project maintainers regarding our setup procedures, release processes, package creation, and other related tasks.

# Maintainer Onboarding and Best Practices
## Maintainer Onboarding and Best Practices

## Becoming a Maintainer or Triager
### Becoming a Maintainer or Triager

If you are interested in becoming a maintainer, you can join our community. We expect you to be actively involved.
If you are interested in becoming a maintainer, you can join our community. Maintainers have several important responsibilities, so please read on to understand the role.

Also, if you're interested in helping managing issues with labels and interacting with incoming requests, you can have a "triager" role!

## Maintainer Responsibilities and Expectations
To get permissions, please start by participating on GitHub by answering questions, reviewing PRs, or contributing code or documentation. Once you're feeling comfortable, you can ask any of our maintainers for permissions by `@`ing them on GitHub.

### Maintainer Responsibilities and Expectations

1. As a maintainer, there is no strict time obligation, as we understand that everyone's ability to commit can fluctuate. However, we do expect maintainers to communicate openly and transparently with the team and the community.

2. As a maintainer, you are expected to uphold a positive and inclusive team culture. This includes following the guidelines outlined in the [Openscapes team culture page](https://openscapes.github.io/series/core-lessons/team-culture.html) and the [recorded psychological safety talk](https://www.youtube.com/watch?v=rzi-qkl8u5M) . By doing so, you can help ensure that all team members and contributors feel safe, respected, and valued.


## Maintainer Processes Beyond Regular Contributing
### Maintainer Processes Beyond Regular Contributing

1. As a maintainer, label issues clearly and consistently to help contributors identify issue types and priority. Use 'good first issue' for contributor-friendly issues.

Expand All @@ -33,27 +35,24 @@ Also, if you're interested in helping managing issues with labels and interactin

3d. Merge contributions promptly.

4. As a maintainer, you will be releasing different versions. More on this in [here](#making-a-release).
4. As a maintainer, you will be releasing different versions. More on this in [here](./contributing/releasing.md).

# Branches
## Branches

main: This is the main branch, which is consistently tested and prepared for release as a new version. Avoid pushing changes directly to this branch. Instead, create a new branch and submit a pull request for any modifications.

gh-pages: This branch hosts HTML docs, updated by GitHub Actions. Don't commit directly. Make changes in a separate branch, then submit a pull request. GitHub Actions will automatically update docs on gh-pages when merged.

# Continuous Integration
## Continuous Integration & Delivery

The GitHub Actions CI services handle the project's building, testing, and management across Linux, macOS, and Windows platforms. The CI file manages the continuous integration processes, and list out their respective dependencies. Here we briefly summarize the functions of the files in CI.
The GitHub Actions CI services handle the project's building, testing, and management across Linux, macOS, and Windows platforms. The CI files can be found in the `./.github/workflows/` which manage the continuous integration process, the dependencies are listed out in the `./ci/environment-dev.yml` file. Here we briefly summarize the functions of the files in the `./ci/` directory.

```environment-dev.yml ``` - The environment configuration file specifies dependencies for Python development.
`environment-dev.yml` - The environment configuration file specifies dependencies for Python development.

```environment-mindeps.yaml``` - The test-environment file lists required and test dependencies for a testing environment.
`environment-mindeps.yaml`- Specifies an environment with the minimum supported dependency versions to detect backwards-incompatible code.

# Continuous Documentation
## Continuous Documentation

The Read the Docs service is used to preview documentation changes made in pull requests. This service uses a configuration file, ```.readthedocs.yaml```.
[ReadTheDocs](https://readthedocs.org/projects/earthaccess/) is used to generate and host [our documentation website](https://earthaccess.readthedocs.io/) as well as the preview for documentation changes made in pull requests. This service uses a configuration file in the root of the project, `.readthedocs.yml`.

# Making a Release

To automate releases, we employ a script called ```publish.sh``` in the scripts folder. This script utilizes Poetry for managing and publishing the package to PyPI.

0 comments on commit b4d27f7

Please sign in to comment.