From c2efa9bc189f2a4a896fcceb952b3a17d29c33ea Mon Sep 17 00:00:00 2001 From: kiranpranay Date: Sat, 7 Oct 2023 12:26:12 +0530 Subject: [PATCH] opencodelaw: Add Contribution Guidelines Signed-off-by: kiranpranay --- CONTRIBUTION.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..9d6a455 --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,26 @@ +# Contribution Guidelines + +Thank you for considering contributing to our project! Before you start, please read the following guidelines to ensure a smooth contribution process. + +## Stylesheet Compilation + +We are using `style.scss` as our main stylesheet. To compile SCSS into CSS, follow these steps: + +1. **Install Live Sass Compiler:** + Make sure you have "Live Sass Compiler" installed in your development environment. You can install it using Visual Studio Code or any other compatible code editor extensions marketplace. + +2. **Compile `style.scss`:** + Configure your Live Sass Compiler to compile `style.scss` into `style.css`. Please ensure that you do not modify `style.css` directly. All your changes should be made in `style.scss`. + +## JavaScript Changes + +All script changes, additions, or modifications must be done in `js/opencodelaw.js` file. Please refrain from scattering scripts across multiple files for better code organization and maintainability. + +## Pull Request Guidelines + +- Fork the repository and create your branch from `main`. +- Ensure your code adheres to the existing coding style and standards. +- Provide a clear and descriptive title for your pull request. +- Reference the issue numbers your pull request addresses (if applicable). + +Thank you for your contribution! :tada: