Welcome to Sunflower Land docs contributing guide Thank you for joining our journey and helping us build the #1 Community Metaverse game
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
New contributor guide To get an overview of the project, please read the README.
Here are some resources to help you get started with open source contributions:
Disclaimer By contributing to this repository you provide Sunflower Land the ownership of any IP contributed to the project to use indefinitely. This includes code, discussions (ideas) and all types of artwork. While often designers and developers are rewarded with the NFTs and airdrops, there is no guarantee of reward.
You confirm you have the rights to the content you are contributing to the project.
Getting started Please read the README.md for details on how to setup and run the repo locally.
Issues Create a new issue If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Solve an issue Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.
As a general rule, we assign features with deadlines to core team members. If a ticket is already assigned and you are passionate about it, please reach out to the developer on the issue comments and help them out.
How can I help? If you have a bright idea, open an issue or join our active Discord #devs-chat first and start a discussion. We love to bring in the community ideas where possible!
Don't have any ideas? We would suggest scanning the open issues and seeing if there is something that catches your eye.
You can search by labels as well to see which items are more urgent than others.
What should I work on? Maintaining a project with over 50 open source developers brings a range of challenges:
Maintaining a consistent vision Ensuring best architecture practices Security concerns and vulnerabilities Automated and manual testing Readability and maintainability Managing expectations, deadlines and contributors leaving the project Tokenomics design Anything that gets added to the project is more code that needs to be maintained by Thought Farm. While we appreciate UI and gameplay PRs, we need these pieces of work to fit into the core team's development workflow to ensure work is pair programmed, has sufficient automated testing, is understood by the team, is peer reviewed, aligns with the tokenomics of the game and adheres with the vision of the project.
Due to the limited time resources of the team, at this point of time, we cannot accept any PRs that introduce major gameplay changes or UI workflows.
If you have an idea that introduces new UI workflows or gameplay, the best way forward is to first raise the idea for community and if consensus is met, it will get added to the roadmap. Once an item is on the roadmap, the core functionality will be developed by Thought Farm with the support from certified developers and and the community. For new gameplay and UI workflows there will be plenty of tasks that can be worked on by community members.
Examples of what can be worked on independently
Bug fixes Decorations Minor UI enhancements - Typos, buttons, alignment, colours CI & Build improvements Writing tests Animations + game polish Examples of what the core team will need to be involved in
New game features Major UI & UX workflows Architecture changes (state management, data storage, routers etc.) Smart contracts & APIs Testing infrastructure Repo tooling (testing, components, build) Make Changes Make changes locally Ensure you have git installed locally
Fork the repository.
Create a working branch and start with your changes!
Commit your update Commit the changes once you are happy with them. We prefer atomic commits that are easily revertable.
TIP: If your changes include only documentation updates/additions/deletions, make sure that you add below line to your commit message while committing:
[skip ci]
This won't trigger the GitHub Actions CI Workflow in turn, it won't waste the resources. 🤗 🌏
E.g.
[CHORE] Update README.md [skip ci] Preparing to submit Before you submit, ensure you have done the following:
Manually tested your code by running the repo Written tests for any business logic code Provided sufficient comments on the code Pull Request When you're finished with the changes, create a pull request, also known as a PR.
You will want to prefix the name of your PR with the category it falls under:
[FEAT] Feature or enhancement [CHORE] Admin type work (scripts, documentation etc) [FIX] A bug fix For example - "[FEAT] Craft a sausage"
Once you submit your PR, a Sunflower Land team member will review your proposal. We may ask questions or request for additional information. We may ask for changes to be made before a PR can be merged As you update your PR and apply changes, mark each conversation as resolved. If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues. When a PR is opened we run Github Actions to ensure the quality of the code is up to standards. This includes:
Typescript check Jest (unit testing) Your PR is merged! Congratulations 🎉🎉 The Sunflower Land team thanks you ✨.