69 lines (57 loc) · 1.6 KB

Contributing to Nextellar

Thank you for considering contributing! We welcome contributions of any size. To get started, please follow these steps:

1. Fork the Repository

Click the “Fork” button at the top right of the repo.

Clone your fork:

git clone git@github.com:<your-username>/nextellar.git
cd nextellar

2. Set Up Your Development Environment

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```
(Optional) Install globally for testing:
```
npm link
```

3. Create a Branch

Use descriptive branch names, prefixed by type:

feature/<short-description>
bugfix/<short-description>
docs/<short-description>

Example:

git checkout -b feature/cli-flags

4. Make Your Changes

Follow the existing code style (TypeScript, ESLint, Prettier).
Write tests for new functionality.
Update or add documentation (README, docs site, etc.).

5. Run Tests and Linters

npm run lint
npm test
npm run build

Ensure all checks pass before submitting.

6. Commit and Push

Write clear, concise commit messages.
Push your branch:
```
git push origin feature/cli-flags
```

7. Open a Pull Request

In your fork, click “Compare & pull request.”
Fill out the PR template with details of your changes.
Request review from the maintainers: @Ebubechi and @DavidDumtochukwu.

8. Code Review & Merge

Address any feedback.
Once approved, your PR will be merged and you’ll be credited as a contributor!

Thank you for helping make Nextellar better! 🎉