Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 1.96 KB
Raw

Contributing to dotemd

We welcome contributions to dotemd! This document outlines is the guidelines for contributing to this project.

Creating Issues

If you encounter a bug or have a feature request, please report it by creating an issue in the GitHub issue tracker.To create a new issue:

  1. Go to the GitHub issue tracker.
  2. Click the "New Issue" button.
  3. Provide a descriptive title for the issue.
  4. In the issue description, explain the problem or feature request in detail.
  5. Add relevant labels to the issue.

Refactoring

If you want to contribute to the project by refactoring code, please follow these steps:

  1. Create an issue for the refactoring you want to perform.
  2. Describe the changes you want to make in detail.
  3. Wait for approval from the maintainers before starting work.

Being Respectful

Please be respectful when interacting with other contributors. We have a code of conduct in place that outlines expected behaviour in the project. Be mindful of others' opinions and avoid engaging in personal attacks or disrespectful language.

Installation

1. Clone the Repo

git clone https://github.com/ashrafchowdury/dotemd.git

2. Move to the project

cd dotemd

3. Install dependencies

npm install

4. Setup .env file

NEXT_APPWRITE_DATABASE_ID=
NEXT_APPWRITE_COLLECTION_ID=

// optinal
NEXT_PUBLIC_APPWRITE_PUBLIC_DATABASE_ID=
NEXT_PUBLIC_APPWRITE_PUBLIC_COLLECTION_ID=

5. Run the application

npm run dev

6. After changes Run

npm run format

Important Notes

  • You have to use the camelCase to write any sort of name.
  • Please ensure that your contributions are in line with the project's goals and direction.
  • Before submitting a pull request, make sure that your changes are up to date with the latest version of the main repository.
  • Please be patient when waiting for a response to your issue or pull request. The maintainers are volunteers and may not be able to respond immediately.