Skip to content

Latest commit

 

History

History
97 lines (55 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

97 lines (55 loc) · 3.21 KB
Raw

Contributing

I would ❤️ you to contribute to House Arena and help make it better! I want contributing to House Arena to be fun, enjoyable, and educational for anyone and everyone.

All contributions are welcome, including issues, and new docs.

Setup From Source

To set up a working development environment, just fork the project git repository and clone your fork.

install dependencies in project local folder, then run

npm install

now simply start your project by

npm run dev

User Interface

House Arena's UI is built with React, Redux, and the Ant D component library.

Get Started

After finishing the installation process, you can start writing and editing code.

Advanced Topics

We love to create issues that are good for beginners and label them as good first issue, but some more advanced topics might require extra knowledge.

Submit a Pull Request 🚀

Branch naming convention is as following

ISSUE_ID-DESCRIPTION

All PRs must include a commit message with the description of the changes made!

For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:

  1. git pull, before creating a new branch, pull the changes from upstream. Your main needs to be up to date.
$ git pull
  1. Create a new branch from main like: 548-submit-a-pull-request-section-to-contribution-guide.
$ git checkout -b [name_of_your_new_branch]

  1. Work - commit - repeat (make sure you're on the correct branch!)

  2. Push changes to GitHub.

$ git push origin [name_of_your_new_branch]
  1. Submit your changes for review If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
  2. Start a Pull Request Now submit the pull request and click on Create pull request.
  3. Get your code reviewed.

Dependencies

Please avoid introducing new dependencies to House Arena without consulting the maintainer. New dependencies can be very helpful, but they also introduce new security and privacy risks, add complexity, and impact the total project size.

Adding a new dependency should have vital value for the product with minimum possible risk.

Introducing New Features

We would 💖 you to contribute to House Arena

For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.

This will allow the us to sufficiently discuss the new feature value and how it fits within the product roadmap and vision.

Other Ways to Help

Pull requests are great, but there are many other ways you can help House Arena.

Sending Feedbacks and Reporting Bugs

Sending feedback is a great way for us to understand your different use cases of House Arena better. If you had any issues, bugs, or want to share your experience, feel free to do so on our GitHub issues page or at mail House Arena.

Improving Documentation

Submitting documentation updates, enhancements, designs, or bug fixes, as well as spelling or grammar fixes is much appreciated.