Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
173 lines (111 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

173 lines (111 loc) · 4 KB

Here's a single CONTRIBUTING.md file with a note stating that contributions are currently not open but will be in the future:

🤝 CONTRIBUTING GUIDE

Thank you for your interest in DirKit! Currently, contributions are not open to the public, but we plan to open contributions in the near future. In the meantime, feel free to follow the instructions below to get familiar with the project and prepare for future contributions.

📖 Table of Contents

📝 Code of Conduct

We aim to maintain an inclusive and respectful community. Please adhere to the Code of Conduct to ensure productive interactions.

🚀 How to Get Started

  1. Clone the Repository:
git clone https://github.com/your-username/dirkit.git
  1. Navigate to the Project Directory:
cd dirkit

🛠️ Development Setup

Prerequisites

Make sure you have the following installed on your system:

  • Node.js (v14 or higher)
  • npm (Package Manager)
  • Git

Install Dependencies

Run:

npm install

🔧 Making Changes

  • When you're familiarizing yourself with the project, feel free to explore and make local changes.
  • Follow Prettier and ESLint rules to maintain consistent code formatting and style.

📜 Commit Guidelines

Commit Message Format

<type>: <subject>

<body (optional)>

<footer (optional)

Types:

  • feat: New feature
  • fix: Bug fix
  • chore: Maintenance and refactoring tasks
  • docs: Documentation updates
  • style: Code formatting changes
  • test: Adding or fixing tests
  • ci: Continuous Integration updates

Example

feat: add CLI support for exporting directory tree

- Added a CLI flag to export directory tree depth control
- Updated documentation with usage examples

✅ Testing

  • Ensure that all tests pass before committing any changes:
npm test
  • Run unit tests located in the tests/ folder:
npm run test:unit
  • Check for lint errors:
npm run lint

📢 Submitting a Pull Request

Currently, contributions are not open to external contributors. However, this may change in the future. In preparation, make sure you:

  1. Create a branch according to the naming convention:
git checkout -b feature/your-feature-name
  1. Push your changes to your forked repository:
git push origin feature/your-feature-name

🧐 Code Review Process

  • When contributions open in the future, all pull requests will undergo a review process.
  • Ensure that your code follows the project's coding guidelines and passes all tests.
  • Be open to feedback and commit any changes requested by maintainers.

🚧 Future Contribution Plans

We are actively working on refining the codebase and documentation to make DirKit contribution-ready. In the coming months, we will:

  • Open up issues for features and bug fixes
  • Establish comprehensive guidelines and tests
  • Welcome contributions from the community!

Stay tuned for updates, and prepare to contribute your expertise to make DirKit even better!

🤝 Additional Resources

🚀 Thank you for your interest in DirKit! Contributions will soon be open, and we're excited to have you join our community once that happens! ✨

Let me know if you want any tweaks or additional sections! 😊