CONTRIBUTING.md

Contributing to the repository

Below instructions are take from "Welcome to GitHub docs contributing guide" and shortened down

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

Issues

Create a new issue

If you spot a problem with the repository you can open a new issue using a relevant issue form.

Solve an issue

If you want to contribute then look at existing issues. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes to the code

Make changes locally

1. Install Git on your computer

2. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• Using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

3. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.

Pull Request

• When you're finished with the changes, create a pull request, also known as a PR.

• Don't forget to link PR to issue if you are solving one.

• If accepted from the review then it can be merged. Else suggestions on how to updated the fix will be made.

Your PR is merged!

Congratulations 🎉🎉

Once your PR is merged, your contributions will be publicly visible on the repository.

Windows

This site can be developed on Windows, however a few potential gotchas need to be kept in mind:

1. Regular Expressions: Windows uses \r\n for line endings, while Unix based systems use \n. Therefore when working on Regular Expressions, use \r?\n instead of \n in order to support both environments. The Node.js os.EOL property can be used to get an OS-specific end-of-line marker.
2. Paths: Windows systems use \ for the path separator, which would be returned by path.join and others. You could use path.posix, path.posix.join etc and the slash module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write scripts in JavaScript instead of Bash.
4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with msys. While the suggestions below are not guaranteed to work and could possibly cause other issues, a few workarounds include:
   • Update Git configuration: git config --system core.longpaths true
   • Consider using a different Git client on Windows