Skip to content

Latest commit

 

History

History
75 lines (62 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

75 lines (62 loc) · 2.96 KB

Contributing to Accessible Web Dev

Languages

This project is built with Next.JS, Typescript and CSS modules.

Pre-requisites (these need to be installed on your machine)

Node.js
Yarn Package Manager

Available packages

Icons - React Icons Documentation
Code Snippets - React Syntax Highlighter Documentation
Translations - next-i18next Documentation
Storybook - Storybook Documentation

How to contribute

  1. Look through Pre-existing issues or Raise a new issue and ask to be assigned. Pull requests made without a corresponding issue will likely be closed.

  2. Please check the coding standards page before start contributing.

  3. Fork the project

  4. Clone the project:

    git clone https://github.com/<your-github-username>/AccessibleWebDev
  5. Navigate to the project directory:

    cd AccessibleWebDev
  6. Set the upstream repository:

    git remote add upstream https://github.com/AccessibleForAll/AccessibleWebDev.git
  7. Install dependencies:

    yarn install
  8. Create a new branch:

    git checkout -b <YourBranchName>
  9. To run the whole project locally:

    yarn dev

    If you are making an isolated component and wish to run storybook locally instead of the whole website run this instead of yarn dev:

    yarn storybook
  10. Make your changes

  11. Stage your changes:

    git add <NameOfFileChanged>
  12. Commit your changes and provide a meaningful commit message:

    Unsure how to write a meaningful commit message? Check out this article about How to Write a Good Git Commit Message

    git commit -m "<Your commit message here>"
  13. Push your commits to your local repository

    git push origin <YourBranchName>
  14. Create a pull request

  15. Wait for maintainers to review your pull request and suggest any changes

Congratulations! You made a contribution to the Accessible For All Community!

Questions?

If at any time you need help with contributing, please reach out to the maintainers