From c5fac019c6709a1b716bc6584f949cf8cc2a22ad Mon Sep 17 00:00:00 2001 From: Razzat Date: Sat, 21 Sep 2024 09:39:48 +0545 Subject: [PATCH 1/2] Edit: linked CONTRIBUTING.md in README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b369e65..9059d6c 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ $ GIT_USER= yarn deploy If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. -### Contributing - -You can contribute in this repository by forking it, creating a separate branch to do the task, making some changes, and creating pull request in this repository. +## Contributing +For contributions see [CONTRIBUTING.md](CONTRIBUTING.md). **Warning:** DONOT use `npm` or `pnpm` to install dependencies. Rather, just use `yarn`. Github actions will fail if you use anything other than yarn. + From 8c7b24ebc1d95a73253c41f95b74323f832e97f9 Mon Sep 17 00:00:00 2001 From: Razzat Date: Sat, 21 Sep 2024 09:40:59 +0545 Subject: [PATCH 2/2] Add: contributing guidelines added - added guidelines to open issue/pr - added guidelines for commit messages --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..703a5e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing +This article demonstrates how you can contribute to projects under KUOSC. + +## How to report bugs,issues? +If you think you have experienced and unexpected behaviour or possibly a bug. + +- Check if any related issue(s) is/are [already](https://github.com/kuosc2005/website/issues) open. +- If none exist, open a [new](https://github.com/kuosc2005/website/issues/new/choose) one. + +### What to include in a new issue? + +- [Labels](https://github.com/kuosc2005/website/labels) depending on the type of issue(s) +- Expected behaviour +- Observed behaviour +- Steps to reproduce +- Include log(s) if available +- The host environment(optional) + +## Have any suggestions or new ideas instead? + +- Create an issue and [label](https://github.com/kuosc2005/website/labels) it accordingly + +## Contributing to the codebase +Contributing to this project is easy, and we welcome contributions from everyone. Here are a few guidelines to get you started: +behavior + +- [Fork](https://github.com/kuosc2005/website/fork) the repository +- Clone the repository +- Make your changes +- Test your changes +- Commit your changes +- Push your changes +- Submit a [pull request](https://github.com/kuosc2005/website/pulls) + +### What to include in a pull request(PR)? + +- Changes made in the codebase +- If any issues are addressed, reference it in the body + +### Writing Commit Messages + +- **Use the imperative mood**: Start with an imperative verb, such as "Fix", "Add", "Update","Change" etc. +- **Keep it concise**: Limit the subject line to 50 characters and use the body to provide additional context if necessary. +- **Reference related issues**: If your commit addresses a specific issue or task, reference it in the body of pull request using the issue number (eg: Resolved #69). + +Example: +```txt +Add: blog for sfd +Fix: avatar image distortion +```