Skip to content
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.

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

Enhance README for Contributions and Technical Clarity #7330

Closed
wants to merge 1 commit into from

Conversation

UTSAVS26
Copy link

Description

  • Improved the introduction to highlight the open-source nature of the project and its goals.
  • Expanded the contributing section to provide clearer guidelines for developers looking to contribute.
  • Added detailed instructions for setting up a development environment, including dependencies and project structure.
  • Clarified data sources and methodology, emphasizing the importance of consumption-based carbon intensity.
  • Included community support channels for developers, such as Slack and GitHub Discussions.
  • Enhanced accessibility of information regarding the API and historical data access.

Double check

  • I have tested my parser changes locally with poetry run test_parser "zone_key"
  • I have run pnpx prettier@2 --write . and poetry run format in the top level directory to format my changes.

- Improved the introduction to highlight the open-source nature of the project and its goals.
- Expanded the contributing section to provide clearer guidelines for developers looking to contribute.
- Added detailed instructions for setting up a development environment, including dependencies and project structure.
- Clarified data sources and methodology, emphasizing the importance of consumption-based carbon intensity.
- Included community support channels for developers, such as Slack and GitHub Discussions.
- Enhanced accessibility of information regarding the API and historical data access.
@VIKTORVAV99 VIKTORVAV99 self-requested a review October 17, 2024 09:26
Copy link
Member

@VIKTORVAV99 VIKTORVAV99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry but I'll not be merging this PR. At least as is.

There are potentially some good changes in here to some of the wording but sorting alt attributes and changing image links (that don't even seem to work BTW) does not require a PR.

If there are specific changes you want to make please open individual PRs for them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants