Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Latest commit

 

History

History
128 lines (86 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

128 lines (86 loc) · 3.77 KB
Raw

Contributing

First off, thank you for considering contributing to Linkify. It's people like you that make Linkify such a great project.

Where can I go for help?

If you need help, you can join our discord server.

Discord

Contribution Guidelines

Want to add your inputs to the repo? We invite you to contribute. To start contributing, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/Linkify.git

3. Navigate to the project directory 📁 .

cd Linkify

4. Add a reference (remote) to the original repository.

git remote add upstream https://github.com/Design-and-Code/Linkify.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes ✔.

git add .

10. Commit your changes.

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on Compare & pull requests.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create pull request.

15 Voilà! You have made a PR to Linkify 💥. Wait for your submission to be accepted and your PR to be merged.

Report a bug

If you find a security vulnerability, do NOT open an issue. Email us instead.

Follow these steps to report a bug

  • Head over to issues tab.
  • Click on New issue in top right corner.
  • Choose Bug report among the various options.
  • Fill out the form.
  • Click on Submit new issue.

Things to keep in mind while reporting a bug

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

  • What is your environment?
  • What steps will reproduce the issue?
  • What browser(s) and OS experience the problem?
  • What would you expect to be the outcome?
  • Provide adequate screenshots/log for the bug.

All these details will help developers to fix any potential bugs.

Create a feature request

If you find yourself wishing for a feature that doesn't exist in Linkify, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Linkify has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Follow these steps to create a feature request

  • Head over to issues tab.
  • Click on New issue in top right corner.
  • Choose Feature request among the various options.
  • Fill out the form.
  • Click on Submit new issue.

Things to keep in mind while creating a feature request

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.