Skip to content

Latest commit

 

History

History
59 lines (30 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

59 lines (30 loc) · 3.66 KB
Raw

Contribution Guidelines

So you are wondering how can you contribute to Hashnode Support? Congrats, you’ve landed on the right page!

How can I contribute?

There are multiple ways in which you can help us:

  • Found a bug in the Support Site? Report it to us!

  • Caught a typo in documentation or want to make it better to understand? Edit it!

  • Know how to fix an issue or add a new feature? Make a patch!

  • Loved the Hashnode support? Share it with others!

Anything we missed to mention? Then, what are you waiting for!

Reporting a Bug

Hashnode Support is in active development. So if you have suggestions about how can we improve some functionality. Feel free to share any of it with us by opening an issue here.

Note: Make sure you are raising requests against Hashnode Support, not Hashnode itself. For raising requests against Hashnode use the feature request page.

Please make sure that you provide all the necessary information in the issue body - it will not only make our work easier but will also help you to communicate your problem better.

Editing the Suppport Guides

There is always a scope of improvement in guides to add some missing information or to make it easier for reading. And here lies an opportunity for you, since you can edit the guides you want which is stored as markdown files in docs directory of Hashnode Guide Repository.

After editing the file locally, build the docs as described in these instructions and then you can submit your changes to us by creating a PR as described in the next section.

Editing Existing Pages

To edit an existing page, locate its .md source file and open it in your favorite text editor. After making the necessary changes, commit the changes, push them to your fork and make a pull request.

Adding New Pages

To add a new page, create a .md file with a meaningful name in the docs directory. Write its content like you would do for any other markdown file, and make sure to define an id and title for your page in the starting.

You should then add your page to the relevant section by adding the id of the document to the sidebars.js file. You can create more sections (if required) using the sidebars.js file itself.

Creating a PR

If you have peeked in our codebase and realized how you can fix a problem or if you know how to add a new feature, well done! If not, don’t worry - just pick an easy or good-first issue and get started to fix it.

  • To contribute your code to Hashnode Support, you’ll need to make a pull request from your fork of Hashnode Guide repository. This development workflow using Git may look daunting at first, but there are multiple articles on Hashnode that will help you understand Git workflow better.

  • When you make a pull request, please provide all the necessary information in the pull request body. Also, make sure that the code you’re submitting is well documented and tested.

Spreading the word of mouth

If you find Hashnode Support helpful, you can share it with your peers, colleagues, and anyone who can benefit from Hashnode.

What if I need help?

If you need have any questions or require clarifications, please reach out to us on Discord without any hesitation. We already appreciate that you’re trying to help us, so feel free to ask any doubt you have or whatever is keeping you stuck.