|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +This ecosystem relies on the following tools and libraries: |
| 6 | +- Node.js and npm |
| 7 | + |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +Contributions to the ecosystem are welcome and encouraged! Here's how you can get started: |
| 12 | + |
| 13 | +- Fork the repository |
| 14 | +- Clone your forked repository |
| 15 | +- Create a new branch |
| 16 | + - `feat/<feature-name>` for new features |
| 17 | + - `fix/<issue-name>` for bug fixes |
| 18 | + - `docs/<topic>` for documentation updates |
| 19 | +- Make your changes |
| 20 | +- Commit your changes |
| 21 | + - Add a message that explains the commit |
| 22 | + - Preferably, make small and focused commits |
| 23 | + - Make as many commits as you need, as long as sensible |
| 24 | + - Avoid weird messages like "stuff" (it's reserved for [AttAditya](https://github.com/AttAditya) only, since he's the only one maintaining the repository and can understand what "stuff" means since he wrote the code) |
| 25 | +- Push your changes to your forked repository |
| 26 | +- Open a pull request to the main repository |
| 27 | + - Start with the PR template |
| 28 | + - Provide a clear description of your changes and the problem they solve |
| 29 | + - Reference any related issues (e.g., "Fixes `#<issue-number>`") |
| 30 | + - Be responsive to feedback and make necessary revisions |
| 31 | +- Celebrate your contribution to the ecosystem! |
| 32 | + |
| 33 | +## Development Environment |
| 34 | + |
| 35 | +This project uses a source file `dev.sh` to set up the development environment. To get started, follow these steps: |
| 36 | + |
| 37 | +```sh |
| 38 | +# Clone the repository |
| 39 | +git clone https://github.com/<your-username>/<repository-name>.git |
| 40 | +cd <repository-name> |
| 41 | + |
| 42 | +# Source the development environment |
| 43 | +source dev.sh |
| 44 | + |
| 45 | +# Setup and run |
| 46 | +dev setup |
| 47 | +dev run |
| 48 | +``` |
| 49 | + |
| 50 | +### Available Commands |
| 51 | + |
| 52 | +Use the `dev` command to view and understand the available commands. Here are important commands: |
| 53 | + |
| 54 | +- `dev setup`: Sets up the development environment, including installing dependencies and configuring necessary tools. |
| 55 | +- `dev run`: Runs the main application or specific components for testing and development purposes. |
| 56 | +- `dev fmt`: Formats the codebase according to the project's coding standards. |
| 57 | +- `dev build`: Builds the project for production. |
| 58 | +- `dev start`: Starts the project in production mode. |
| 59 | + |
| 60 | + |
0 commit comments