Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
52 lines (32 loc) · 3.66 KB

CONTRIBUTION.md

File metadata and controls

52 lines (32 loc) · 3.66 KB

How to contribute for Tecxick Web Animation Library

Tecxick is a web animation library that provides a simple and expressive way to create animations using HTML, CSS and JavaScript. It is designed to be easy to use, flexible and performant. If you are interested in contributing to this project, here are some guidelines and tips to help you get started.

Prerequisites

Before you start working on Tecxick, make sure you have the following tools installed on your system:

  • Git: You will need Git to clone the repository and manage your changes.
  • A code editor: You can use any code editor of your choice, but we recommend using Visual Studio Code with the ESLint and Prettier extensions for code formatting and linting.

Getting the code

To get the code, you will need to fork the repository on GitHub and clone it to your local machine. To do that, follow these steps:

  • Go to https://github.com/tecxick/Tecxick-Web-Animation-Library and click on the Fork button on the top right corner. This will create a copy of the repository under your GitHub account.
  • On your GitHub account, go to the forked repository and copy the URL from the Clone or download button.
  • On your terminal, run git clone https://github.com/tecxick/Tecxick-Web-Animation-Library. This will download the code to your local machine.
  • On your terminal, run cd Tecxick-Web-Animation-Library to enter the project directory.

Making changes

To make changes to Tecxick, you will need to create a new branch from the main branch. To do that, follow these steps:

  • On your terminal, run git checkout -b <branch-name> where <branch-name> is a descriptive name for your branch. For example, git checkout -b fix-bug-123.
  • Make your changes in the code using your code editor. You can use the examples in the examples folder to test your changes.
  • Commit your changes using git commit -m "<message>" where <message> is a concise summary of what you did. For example, git commit -m "Fix bug 123 in animation.js".
  • Push your changes to your forked repository using git push origin <branch-name>. For example, git push origin fix-bug-123.

Creating a pull request

To create a pull request, you will need to submit your changes to the original repository for review. To do that, follow these steps:

  • Go to https://github.com/tecxick/Tecxick-Web-Animation-Library and click on the New pull request button on the top right corner.
  • Select your forked repository and branch from the Compare across forks dropdown menus.
  • Click on Create pull request.
  • Fill in the title and description of your pull request. Explain what you did, why you did it, and how it can be tested. Reference any related issues or pull requests if applicable.
  • Click on Create pull request.

Reviewing and merging

After you create a pull request, it will be reviewed by one of the maintainers of Tecxick. They may ask you for some feedback or changes before merging it. To update your pull request, you can make more commits on your branch and push them to your forked repository. They will automatically appear on your pull request.

Once your pull request is approved and merged, you can delete your branch from your forked repository and local machine.

Code of conduct

Tecxick is an open source project that welcomes contributions from anyone who respects our code of conduct. Please read it carefully before participating: https://github.com/tecxick/Tecxick-Web-Animation-Library/blob/main/CODE_OF_CONDUCT.md

Thank you

Thank you for considering contributing to Tecxick. We appreciate your time and effort. If you have any questions or suggestions, please feel free to open an issue or contact us on our Discord server: https://discord.gg/X6xXxZCNFC