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

Documentation: add "name" option #125

Closed
gr2m opened this Issue Aug 13, 2017 · 6 comments

Comments

Projects
None yet
4 participants
@gr2m
Copy link
Member

gr2m commented Aug 13, 2017

This is a starter issue.

🆕🐥☝ First Timers Only

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝 About First Timers Only.

🤔 What you will need to know

No coding or git skills are required to work on this issue. You can edit the Configuration Guide source file directly on github.com, you don’t even need to install anything on your computer – unless you want to, of course :)

Here is the current version of the Configuration Guide: http://docs.hood.ie/en/latest/guides/configuration.html

In the Options table there is an option missing: name. Its default value is the application’s package.json’s "name" value.

The name option is used in the application’s admin dashboard and in the route prefix of app-specific plugins.

📋 Step by Step

  • 🙋 Claim this issue: Comment below (or assign yourself and continue at step 4 :)
    Please 🙏 only claim if you want to start working on it within a day.
    Once claimed we add you as contributor to this repository.
  • 👌 Accept our invitation to this repository. Once accepted, assign yourself to this repository
  • 👓 Please review our Code of Conduct
    In a nutshell: be patient and actively kind with us 😊
  • 🔄 replace the up for grabs label with in progress.
  • Click the 🖊 icon on the top right of the configuration.rst file
  • Add a new row for the name option between inMemory and port (they are alphabetically sorted)
  • Scroll to the bottom of the page and set the text input below Commit changes to docs(configuration guid): add "name" option. Click the green "Propose file change" button
  • On the next page Click the green "Create pull request" button. Congratulations, you just created a pull request
  • 🏁 Done 👍 Replace the in progress label with ready. Ask in comments for a review :)

🤔 Questions

Ping us in the Hoodie Chat or on Twitter

@gr2m gr2m added the Documentation label Aug 13, 2017

@gr2m

This comment has been minimized.

Copy link
Member Author

gr2m commented Aug 15, 2017

@aylincakal is working on it at hoodiehq/hoodie#796

@usmandap

This comment has been minimized.

Copy link
Collaborator

usmandap commented Aug 19, 2017

@gr2m Hey let me know if anyhow she is not working. May be I can contribute.

@gr2m

This comment has been minimized.

Copy link
Member Author

gr2m commented Aug 20, 2017

@usmandap Aylin asked me to open up the issue for other people, so if you are still interested, the issue is all yours :) I’ve invited you as collaborator to this repository so you can check of the checkboxes above 👍

@ojas1234

This comment has been minimized.

Copy link

ojas1234 commented Sep 16, 2017

@gr2m Hey I'm a newbie. Can i contribute ?
I had never contribute to open source. how can i start?

@harshil1712

This comment has been minimized.

Copy link

harshil1712 commented Sep 19, 2017

Hello. I would like to contribute. I am a newbie. Please let me know how can I contribute.

@gr2m

This comment has been minimized.

Copy link
Member Author

gr2m commented Sep 19, 2017

The issue has been resolved via hoodiehq/hoodie@f14cd93.

I’m sorry we don’t have open issues right now that we could use to onboard more contributors. I’ll let you know once we have some. You can also watch this repository :)

@gr2m gr2m closed this Sep 19, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.