Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update the Section on Keep files

Open
  • Is something wrong?
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by locating the documentation section covering “keep” files and review its current explanation. Update it to explain when and how keep files can be used, plus alternatives when they cannot be used; done means all three points are clear in the revised documentation.

Written by the indexing model from the issue text.

Description

Our documentation on using 'keep' files is very unclear. We need to highlight when it can be used, how it can be used, and what are the alternatives if it cannot be used for a file.

Dominant language
JavaScript
Stars
26
Forks
11
No merged PRs in 30d

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from engineyard/ey-docs

All issues in engineyard/ey-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.