You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
2.9 KiB
Markdown
62 lines
2.9 KiB
Markdown
# Contributing
|
|
|
|
Thank you for your interest in contributing to BossRoom!
|
|
|
|
Here are our guidelines for contributing:
|
|
|
|
* [Code of Conduct](#coc)
|
|
* [Ways to Contribute](#ways)
|
|
* [Issues and Bugs](#issue)
|
|
* [Feature Requests](#feature)
|
|
* [Improving Documentation](#docs)
|
|
* [Unity Contribution Agreement](#cla)
|
|
* [Pull Request Submission Guidelines](#submit-pr)
|
|
|
|
## <a name="coc"></a> Code of Conduct
|
|
|
|
Please help us keep BossRoom open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## <a name="ways"></a> Ways to Contribute
|
|
|
|
There are many ways in which you can contribute to the BossRoom.
|
|
|
|
### <a name="issue"></a> Issues and Bugs
|
|
|
|
If you find a bug in the source code, you can help us by submitting an issue to our
|
|
GitHub Repository. Even better, you can submit a Pull Request with a fix.
|
|
|
|
### <a name="feature"></a> Feature Requests
|
|
|
|
You can request a new feature by submitting an issue to our GitHub Repository.
|
|
|
|
If you would like to implement a new feature then consider what kind of change it is:
|
|
|
|
* **Major Changes** that you wish to contribute to the project should be discussed first with other developers. We will have a more formal process for this soon. For now submit your ideas as an issue.
|
|
|
|
* **Small Changes** can be directly submitted to the GitHub Repository
|
|
as a Pull Request. See the section about [Pull Request Submission Guidelines](#submit-pr).
|
|
|
|
### <a name="docs"></a> Documentation
|
|
|
|
We accept changes and improvements to our documentation through the [Netcode for GameObjects Documentation repo](https://github.com/Unity-Technologies/com.unity.multiplayer.docs).
|
|
|
|
## <a name="cla"></a> Contributor License Agreements
|
|
|
|
When you open a pull request, you will be asked to enter into Unity's License Agreement which is based on The Apache Software Foundation's contribution agreement. We allow both individual contributions and contributions made on behalf of companies. We use an open source tool called CLA assistant. If you have any questions on our CLA, please submit an issue
|
|
|
|
## <a name="submit-pr"></a> Pull Request Submission Guidelines
|
|
|
|
We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of BossRoom. This means development happens on the **develop branch** and Pull Requests should be submited to it.
|
|
|
|
### Commit Message Guidelines
|
|
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
|
|
|
|
$ git commit -m "A brief summary of the commit
|
|
>
|
|
> A paragraph describing what changed and its impact."
|
|
|
|
### Line Endings Guidelines
|
|
The project is using Unix-style line endings.
|
|
|
|
Follow the instructions in the official [Git Configuration](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration) documentation, the [Formatting and Whitespace](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_formatting_and_whitespace) section, to enable `autocrlf` setting on your machine.
|