FOSS Community University of Kelaniya - Design Guidelines

Welcome to the documentation site for the design guidelines of the FOSS Community at the University of Kelaniya. This repository contains all the necessary guidelines and best practices for design within our community.

Getting Started

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/fossuok/nextra-doc-template.git
   
   cd nextra-doc-template

2. Install dependancies

   npm install

3. Run the development server

   npm run dev

4. Build the project

   npm run build

Testing

Before contributing, please make sure all test cases pass. Run the following command to check for test cases

npm run test

Contributing

We welcome contributions from everyone. To contribute, follow these steps

1. Fork the repository
2. Create a new branch

git checkout -b feature/your-feature-name

3. Make your changes
4. Commit your changes

git commit -m "Add your commit message"

5. Push to the branch

git push origin feature/your-feature-name

6. Create a pull request

   Please ensure your code adheres to the project's coding standards and passes all linting and test checks.

Contributors ❤️

Thank you to all our contributors! If you'd like to contribute, please feel free to submit a pull request.

License

This project is licensed under the MIT License.

If you have any questions or need further assistance, feel free to open an issue or contact the maintainers.

🎊 Happy coding! 🎊