From 2b06bf7c2c23cc6da2cee1ab755cfa71d1b5b909 Mon Sep 17 00:00:00 2001 From: Joshua Thomas <111826880+thomasalex122@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:39:48 +0530 Subject: [PATCH] Improve Contribution Guidelines in readme.md Clear Steps: Outlined steps for forking, making changes, running the linter, building the project, and creating a pull request. Emphasis on Standards: Highlighted the importance of adhering to coding standards and ensuring a successful build. --- readme.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 945b4238..bb87ca5f 100644 --- a/readme.md +++ b/readme.md @@ -45,19 +45,35 @@ npm run deploy This requires you to have commit access to your Git remote. -## Contributions +--- -Fork the repo and make required changes. Afterwards, push your changes in branch. The name will be according to the changes you did. Initiate the pull request. +## How to Contribute -Make sure your editor makes validations according to the `.jshintrc` in the root directory of the repository. +1. **Fork the repo** and create your branch from `main`. +2. **Make your changes**, adhering to the project's coding standards. +3. **Ensure your code passes the linter**: + ```bash + npm run lint + ``` +4. **Run the build process**: + ```bash + npm run build + ``` + - If the build fails, fix the issues in your code. +5. **Create a pull request**. -Before pushing to the repository, run: +## Code Style -```bash -npm run build -``` +- Follow the `.jshintrc` guidelines located in the root directory. + +## Opening Issues + +- For major changes, open an issue first to discuss your ideas. + +Thank you for your contributions! + +--- -If the build is not successful, fix your code in order for the tests and jshint validation to run successfully. Then create a pull request. ## Contributors