Skip to content

kevinktg/thex3family-website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

thex3family logo

This is the repository for the.x3.family website, a resource for the Co-x3 Family Foundation. Our mission is to “To equip students, creatives, and retirees with knowledge to level up every day, tools to put their learning into action, and a community to never struggle alone." - read more about what this means here.

the.x3.family is being improved and changed over time through the contributions of community members who submit content, give feedback, or volunteer their time to manage its evolution.

If you’re interested in supporting us, find out how to contribute. We also host online spaces to have meaningful conversations – come share your ideas or just say hi over in our community.

How To Contribute

Contributions of any kind are welcome! We follow the all-contributors specification, which means we recognize contributors to an open-source project in a way that rewards every contribution, not just code.

1. Submit An Issue

More information on the issue creation process, and expectations around creating issues can be found here.

2. Fork The Repository (repo)

3. Set Up Your Local Environment (optional)

If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.

4. Make Awesome Changes!

  1. Create new branch for your changes
git checkout -b new_branch_name
  1. Start developing!
yarn dev
  1. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword).
git commit -m "brief description of changes [Fixes #1234]"
  1. Push to your GitHub account
git push

5. Submit Your PR

  • After your changes are committed to your GitHub fork, submit a pull request (PR) to the dev branch of the thex3family/thex3family-website repo
  • In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
    • ex. Updates out of date content [Fixes #1234]
  • Vercel (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL.
  • Confirm your GC preview deploy looks & functions as expected
  • Why not say hi and draw attention to your PR in our community?

7. Wait for review

  • The website team reviews every PR
  • Acceptable PRs will be approved & merged into the dev branch

8. Release

  • master is continually synced to Vercel and will automatically deploy new commits to the.x3.family
  • You can view the history of releases, which include PR highlights

Shield: CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0

The development of this website was inspired by the work of ethereum.org. Before implementing any custom elements, we highly recommend exploring their codebase to gain insights and discover solutions that may be applicable to our website's needs.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 78.6%
  • Markdown 21.1%
  • Other 0.3%