Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 20 additions & 48 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,31 @@
# Contribution Guidelines
# Contributing

So you are wondering how can you contribute to Hashnode Support? Congrats, you’ve landed on the right page!
We love your input! We want to make contributing to this support site as easy and transparent as possible, whether it's:

## How can I contribute?
- Reporting a bug
- Submitting a fix
- Proposing new features
- Adding more guides.

There are multiple ways in which you can help us:
When reporting a security vulnerability, please follow these steps:

- Found a bug in the Support Site? Report it to us!
1. Submit a detailed report of the vulnerability, including any relevant code or proof of concept.
2. If the vulnerability is confirmed, we will work with you to resolve the issue and may provide a bounty reward.
3. Please allow our security team time to review and respond to your report.

- Caught a typo in documentation or want to make it better to understand? Edit it!
Refer to our security guidelines for more information on how to report security vulnerabilities.

- Know how to fix an issue or add a new feature? Make a patch!
## Security Vulnerability Reporting

- Loved the Hashnode support? Share it with others!
If you believe you have found a security vulnerability, please submit a report to our security team. We will review your report and respond as soon as possible.

Anything we missed to mention? Then, what are you waiting for!
### Security Vulnerability Report Template

## Reporting a Bug
When submitting a security vulnerability report, please include the following information:

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](https://github.com/Hashnode/support/issues).
* A detailed description of the vulnerability
* Any relevant code or proof of concept
* Steps to reproduce the vulnerability
* Any other relevant information

> Note: Make sure you are raising requests against [Hashnode Support](https://support.hashnode.com/), not [Hashnode](https://hashnode.com/) itself. For raising requests against [Hashnode](https://hashnode.com/) use the [feature request page](https://hashnode.com/feature-requests).

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](https://github.com/Hashnode/support).

After editing the file locally, build the docs as described in these [instructions](https://github.com/Hashnode/support#build) 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](https://github.com/Hashnode/support/blob/main/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](https://hashnode.com/n/github) 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](https://discord.gg/qsAQfxX) 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.
We appreciate your help in keeping our support site secure.