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

Shorten the logged names of HBar Rate Limiting repositories. #3134

Open
11 tasks
ebadiere opened this issue Oct 21, 2024 · 7 comments
Open
11 tasks

Shorten the logged names of HBar Rate Limiting repositories. #3134

ebadiere opened this issue Oct 21, 2024 · 7 comments
Assignees
Labels
good first issue candidate Issues that can become a good first issue but need more description/context. good first issue Good for newcomers hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. internal For changes that affect the project's internal workings but not its outward-facing functionality. Team Promoted

Comments

@ebadiere
Copy link
Contributor

ebadiere commented Oct 21, 2024

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

The current logger configuration uses logger.child({ name: 'hbar-spending-plan-repository' }). This may not be necessary and can make it harder to associate logs with their code sources. Simplifying the logger name for spending plans will improve readability.

Proposed Solution:

Update the logger configuration across the codebase, replacing instances of logger.child({ name: 'hbar-spending-plan-repository' }) with logger.child({ name: 'hbar-spending-plan' }) as shown below:

- logger.child({ name: 'hbar-spending-plan-repository' })
+ logger.child({ name: 'hbar-spending-plan' })

Example Implementation

Refactor the logging configurations by replacing 'hbar-spending-plan-repository' with 'hbar-spending-plan' across all relevant files.

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
  • Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
  • You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

@Ritesh-Udgata
Copy link
Contributor

kindly assign me to this issue

@quiet-node quiet-node added internal For changes that affect the project's internal workings but not its outward-facing functionality. and removed enhancement New feature or request labels Nov 7, 2024
@quiet-node quiet-node modified the milestones: 0.59.0, 0.60.0 Nov 7, 2024
@quiet-node quiet-node added good first issue Good for newcomers good first issue candidate Issues that can become a good first issue but need more description/context. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. labels Nov 7, 2024
@quiet-node
Copy link
Member

@Ritesh-Udgata Thanks for the initiative! Assigned the ticket to you!

@quiet-node quiet-node modified the milestones: 0.60.0, 0.61.0 Nov 11, 2024
@belloibrahv
Copy link
Contributor

@quiet-node I want to know if this ticket is still available to work on.

@quiet-node
Copy link
Member

@belloibrahv Heyy thanks for the initiative but seems like @Ritesh-Udgata has already been assigned to the ticket.

@quiet-node
Copy link
Member

@belloibrahv I'd suggest a more fun and slightly more challenging, yet still beginner-friendly, option is this ticket #3142. If you're interested in working on it, please comment on the ticket, and I can update it to be Hacktoberfest-oriented and assign you to it! I’m also available to assist you along, just like last time with the logging issue.

@quiet-node
Copy link
Member

Hello @Ritesh-Udgata, I wanted to check in and see if you are currently working on this or planning to do so.

@quiet-node quiet-node modified the milestones: 0.61.0, 0.62.0 Nov 26, 2024
@Ritesh-Udgata
Copy link
Contributor

Ritesh-Udgata commented Nov 27, 2024 via email

@quiet-node quiet-node modified the milestones: 0.62.0, 0.63.0 Dec 11, 2024
@quiet-node quiet-node modified the milestones: 0.63.0, 0.64.0 Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue candidate Issues that can become a good first issue but need more description/context. good first issue Good for newcomers hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. internal For changes that affect the project's internal workings but not its outward-facing functionality. Team Promoted
Projects
Status: Backlog
Development

No branches or pull requests

5 participants