Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

87 lines (56 loc) · 2.79 KB
Raw

Contributing

Thank you for your interest in contributing to Watermark KTP! We appreciate your support and effort in making this tool better. Before getting started, please read this contributing guide carefully.

Getting Started

To start contributing to this project, follow the steps below:

  1. Make sure you have the following development environment requirements:

    • Node.js (version 12 or higher)
    • npm (Node Package Manager) or Yarn

  2. Fork this repository to your GitHub account.

  3. Clone the forked repository to your local system:

    git clone https://github.com/yourusername/watermarkktp.git

  4. Navigate to the project directory:

    cd watermarkktp

  5. Install the project dependencies by running the following command:

    npm install

  6. Build project assets, including Eleventy and Tailwind CSS configurations, by running the following command:

    npm run build

  7. Create a new branch for your work:

    git checkout -b branch-name

  8. Start making the desired changes and implement new features as needed.

  9. Run the project locally to test your changes:

    npm run dev

    This will start a local development server using Eleventy. You can access Watermark KTP in your browser via the URL http://localhost:8080.

  10. Once you're done, add the changes you made to the staging area with the following command:

    git add .

  11. After making your changes, create a commit with a descriptive message:

    git commit -m "Brief description of the changes"

  12. Push the commit to your branch in your GitHub repository:

    git push origin branch-name

  13. Create a pull request to the main repository (https://github.com/sirilius/watermarkktp) using the GitHub interface.

Pull Request

To avoid situations where you spend time and effort creating a pull request that is later rejected, we recommend opening an issue first. By opening an issue, you can discuss with us to ensure that the changes you plan to make align with the goals of this project and are in line with the desired development direction.

If you encounter any issues, such as merge conflicts, or don't know how to create a pull request, you can follow the GitHub pull request tutorial to learn how to resolve merge conflicts and other issues. Once your PR is merged, you will be listed as a contributor in the contributor chart.

Contributor

Translation