From 8a57e5ffeb72f605f6e970c6fc536ab40694fe56 Mon Sep 17 00:00:00 2001 From: TarunAdobe Date: Thu, 5 Oct 2023 17:58:31 +0530 Subject: [PATCH 1/2] chore: updated readme and added contrib.md --- .gitignore | 2 + CONTRIBUTING.md | 133 ++++++++++++++++++++++++++++++++++++++++++ README.md | 30 +++++++++- src/pages/index.astro | 22 ++++--- 4 files changed, 172 insertions(+), 15 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index fbe491e..f19a381 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,8 @@ lerna-debug.log* # Diagnostic reports (https://nodejs.org/api/report.html) report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json +.jampack + # Runtime data pids *.pid diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..10558fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,133 @@ +# Contributor's Guide + +First of all, Thanks for taking the time to contribute! 😊 + +**Contents** + +- [Choosing an Issue](#choosing-an-issue) +- [Getting Started](#getting-started) +- [Submitting a Pull Request](#submitting-a-pull-request) +- [Getting Help](#getting-help) + +## Choosing an Issue + +Before getting started and setup with contributing, you'll want to look at and choose an issue to work on. Here is a basic workflow you want to work from: + +1. Search through issues +2. Find issue you want to work on +3. Check if someone else has already worked on and made a pull request on said issue +4. (Optional) Double check pull requests for someone who has worked on the pull request + +If you have gotten that far, then you can go ahead and work on the issue. Below are more detailed instructions based on the basic workflow above. + +You can find open issue [here](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/issues). + +Once you've found an issue you want to work on, take a look at the issue to see if anyone else has made a pull request for this issue yet. + +You can tell if someone has correctly referenced and worked on an issue if in the issue you find some text saying, the following: + +> This was referenced on ____ + +where that `____` is the date and below it is the pull request of another individual working on that issue. [Here](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/issues/822) is an example of what this looks like. + +To be extra sure no one has worked on it, you can [take a look at the pull requests](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/pulls) as well to see if anyone has made a similar pull request. + +If you've gotten this far, then you can continue on with the next section on "Getting Started" to working on your first pull request and contribution to our repository. + +### Getting Started + +1. If you are new to Git and GitHub, it is advisable that you go through + [GitHub For Beginners](http://readwrite.com/2013/09/30/understanding-github-a-journey-for-beginners-part-1/) + **before** moving to Step 2. + +2. Fork the project on GitHub. + [Help Guide to Fork a Repository](https://help.github.com/en/articles/fork-a-repo/). + + ![Illustration for How to Fork a Repository](https://hisham.hm/img/posts/github-fork.png) + +3. Clone the project. + [Help Guide to Clone a Repository](https://help.github.com/en/articles/cloning-a-repository) + +4. Create a branch specific to the issue you are working on. + + ```shell + git checkout -b update-readme-file + ``` + + For clarity, name + your branch `update-xxx` or `fix-xxx`. The `xxx` is a short + description of the changes you're making. Examples include `update-readme` or + `fix-typo-on-contribution-md`. + +5. Open up the project in your favorite text editor, select the file you want + to contribute to, and make your changes. + + If you are making changes to the `README.md` file, you would need to have + Markdown knowledge. Visit + [here to read about GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) + and + [here to practice](http://www.markdowntutorial.com/). + + * If you are adding a new project/organization to the README, make sure + it's listed in alphabetical order. + * If you are adding a new organization, make sure you add an organization + label to the organization name. This would help distinguish projects + from organizations. + +6. Add your modified + files to Git, [How to Add, Commit, Push, and Go](http://readwrite.com/2013/10/02/github-for-beginners-part-2/). + + ```shell + git add path/to/filename.ext + ``` + + You can also add all unstaged files using: + + ```shell + git add . + ``` + + **Note:** using a `git add .` will automatically add all files. You can do a + `git status` to see your changes, but do it **before** `git add`. + +6. Commit your changes using a descriptive commit message. + + ```shell + git commit -m "Brief Description of Commit" + ``` + +7. Push your commits to your GitHub Fork: + + ```shell + git push -u origin branch-name + ``` + +8. Submit a pull request. + + Within GitHub, visit this main repository and you should see a banner + suggesting that you make a pull request. While you're writing up the pull + request, you can add `Closes #XXX` in the message body where `#XXX` is the + issue you're fixing. Therefore, an example would be `Closes #42` would close issue + `#42`. + +### Submitting a Pull Request + +[What is a Pull Request?](https://yangsu.github.io/pull-request-tutorial/) + +If you decide to fix an issue, it's advisable to check the comment thread to see if there's somebody already working on a fix. If no one is working on it, kindly leave a comment stating that you intend to work on it. By doing that, +other people don't accidentally duplicate your effort. + +In a situation where somebody decides to fix an issue but doesn't follow up +for a particular period of time, say 2-3 weeks, it's acceptable to still pick +up the issue but make sure that you leave a comment. + +You can open a pull request to main branch after you have pushed your code. + + +### Getting Help + +We have a [Discord](https://discord.gg/3QXkZ8Q) server where you can ask questions and get help. Feel free to join and ask any questions you may have. + +This is specially useful if you want to work on a new feature or make significant changes to the codebase. + + diff --git a/README.md b/README.md index e322ca8..562358e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,29 @@ -# LainForge.github.io +# About Lainforge​ + +We are a smol group of enthusiastic developers who love to code and learn new things. +All of our projects are open source and can be found [here](https://github.com/LainForge). + +## Lainforge.github.io + +This is our [website](https://lainforge.org/). It is built with [Astro](https://astro.build/) + +Main features of this website are: + +- `Devlogs` + - We write devlogs about our projects and you can follow the entire development process as we go. +- `Tech Posts` + - We write about tech stuff that we find interesting. + +## Setup + +1. Clone the repo +2. Install dependencies with `npm install` +3. Run `npm run dev` to start the dev server + +## Contributing + +If you want to contribute to this project, the best way to do so is by first opening an issue and then creating a pull request. +You can also join our [Discord](https://discord.gg/3QXkZ8Q) and talk to us there. + -Github Actions Done! -> Removed Default Github Pages Action Workflow diff --git a/src/pages/index.astro b/src/pages/index.astro index 140ab14..072dfaa 100644 --- a/src/pages/index.astro +++ b/src/pages/index.astro @@ -25,21 +25,15 @@ const featuredProjects = sortedProjects.filter(({ data }) => data.featured);

Kon'nichiwa​ 🙇🏻

- LainForge is literally the best Open Source Organization in the World! -

-

- Checkout our projects or - - ABOUT - for more info. + At LainForge,

+ +

Scroll down for more ⬇️

-
- { featuredProjects.length > 0 && ( <> @@ -131,4 +125,8 @@ const featuredProjects = sortedProjects.filter(({ data }) => data.featured); .all-posts-btn-wrapper { @apply my-8 text-center; } + + .underline-links { + @apply underline decoration-wavy decoration-1 underline-offset-4; + } From f5760e2df98521a4e10d420caf4454a139e71a43 Mon Sep 17 00:00:00 2001 From: TarunAdobe Date: Thu, 5 Oct 2023 19:58:46 +0530 Subject: [PATCH 2/2] chore: fixed contrib.md --- CONTRIBUTING.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10558fc..c8a65b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,12 +81,6 @@ If you've gotten this far, then you can continue on with the next section on "Ge git add path/to/filename.ext ``` - You can also add all unstaged files using: - - ```shell - git add . - ``` - **Note:** using a `git add .` will automatically add all files. You can do a `git status` to see your changes, but do it **before** `git add`.