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

First draft at README.md #20

Open
readysetagile opened this issue Aug 23, 2022 · 2 comments
Open

First draft at README.md #20

readysetagile opened this issue Aug 23, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@readysetagile
Copy link
Collaborator

As a FCC Columbus contributor
I want to see some instructions on the group's main repository
So that I can get an idea of how I can contribute

@readysetagile readysetagile moved this from New - brand new idea or need, unordered, unrefined. Create the user story. to Ready for refinement - write the acceptance criteria (test script) for the feature in FreeCodeCamp Columbus Website Aug 23, 2022
@readysetagile
Copy link
Collaborator Author

modify the README.md file as needed. might need links to other markdown files in the repo.

  • From amygnb: There are some recommendations for adding Prettier and ESLint extensions to your IDE that would probably be helpful to document in the README.md. The Prettier extension will auto-format on save, which is nice, so that you don't have to wait to have your files formatted in the pre-commit git hook. The ESLint extension will highlight linting warnings and errors as you code, so again, you don't have to wait for that feedback in the pre-commit hook.

Both Prettier and ESLint are configurable, but I left them mostly with just the defaults.

There's a list of "supported editors" on the Prettier site (https://prettier.io/). I've really only ever used VSCode, but I'm assuming that means there are extensions available for the other editors listed. ESLint also has editor integrations, listed here: https://eslint.org/docs/latest/user-guide/integrations#editors

@readysetagile readysetagile moved this from Ready for refinement - write the acceptance criteria (test script) for the feature to In development - at least one person is developing this item in FreeCodeCamp Columbus Website Aug 25, 2022
@readysetagile
Copy link
Collaborator Author

new issue was created for above comment. the content we have now is good.

@readysetagile readysetagile moved this from In development - at least one person is developing this item to Ready to be staged - the feature is currently in the dev environment waiting to be moved to staging environment in FreeCodeCamp Columbus Website Jun 21, 2023
@readysetagile readysetagile moved this from Ready to be staged - the feature is currently in the dev environment waiting to be moved to staging environment to Done! - the feature is in production waiting to be seen by the world! in FreeCodeCamp Columbus Website Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

2 participants