зеркало из
1
0
Форкнуть 0
opensource-management-portal/CONTRIBUTING.md

148 строки
5.4 KiB
Markdown
Исходник Постоянная ссылка Обычный вид История

2022-10-10 08:37:09 +03:00
# Contributing to this project
2022-10-08 01:25:28 +03:00
<!-- This file is currently generic with the exception of mentioning how
2015-12-09 22:45:43 +03:00
to report security-related bugs to Microsoft. -->
2016-07-20 06:58:29 +03:00
This project has adopted the [Microsoft Open Source Code of
Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct
FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com)
with any additional questions or comments.
2022-10-08 01:25:28 +03:00
As an open source project contributions are more than welcome and are
essential to keeping the project interesting and useful. Everyone is
welcome, and there are many ways to contribute to the project beyond
committing source code: consider answering questions on a forum,
2015-12-09 22:45:43 +03:00
reporting bugs or helping to triage and reproduce issues.
<!-- CONSIDER: Community guideline or code of conduct link -->
## Contributors
GitHub provides the most accurate view of the contributions through its
2020-05-30 03:00:35 +03:00
generated graphs feature. Select the "Graphs" tab and
2015-12-09 22:45:43 +03:00
"Contributors" sub-graph.
Thank you!
## License
2022-10-08 01:25:28 +03:00
For more information on this project's licensing, please see the
2015-12-09 22:46:32 +03:00
`LICENSE` file in the root of the repo.
<!-- Not a link, since some projects use LICENSE and others use LICENSE.TXT -->
2015-12-09 22:45:43 +03:00
## How to contribute code
2022-10-08 01:25:28 +03:00
Fixes to existing issues or small incremental improvements can be
2015-12-09 22:45:43 +03:00
submitted as a pull request.
2022-10-08 01:25:28 +03:00
If you're looking to make a larger contribution, refactor code, or add
a major new feature, please first open an issue to start communicating
about the change with the maintainers. This will help to make the process
2015-12-09 22:45:43 +03:00
smooth and lead to the most efficient model.
2022-10-08 01:25:28 +03:00
Changes should be small, incremental, and up-to-date with the upstream.
Large long-term branches can lead to merge conflicts and reduced
2015-12-09 22:45:43 +03:00
collaboration.
### Submitting a pull request
1. Fork the repo on GitHub, cloning on your machine
2. Create a branch with your changes.
2022-10-08 01:25:28 +03:00
2022-10-10 08:37:09 +03:00
- Please keep the branch specific to your contribution
- Please use logical commits with helpful, concise commit messages
- Follow the coding style of the project
- Run follow any build or test scripts. Contribute new tests.
2022-10-08 01:25:28 +03:00
2015-12-09 22:45:43 +03:00
3. Create a [Pull Request](https://help.github.com/articles/using-pull-requests/) with your contribution.
### Contributor License Agreement (CLA) Requirement
2022-10-08 01:25:28 +03:00
This project requires that you have a signed Contributor License
Agreement (CLA) with the copyright holder in order to have your
2015-12-09 22:45:43 +03:00
contribution accepted.
2022-10-08 01:25:28 +03:00
The project may employ an automated pull request bot to review whether
you have already signed a CLA or step you through the process. If it
2015-12-09 22:45:43 +03:00
is not automated, you may need to sign the CLA on a separate site.
### Build, test and style requirements
2022-10-08 01:25:28 +03:00
This project may have continuous integration scripts, unit tests,
code quality and linting tools, etc. that should be used as part
2015-12-09 22:45:43 +03:00
of the contribution process.
2022-10-08 01:25:28 +03:00
If you are an active maintainer on this project, please feel free
2015-12-09 22:45:43 +03:00
to submit a pull request updating this document with any specifics.
## Other ways to contribute
2022-10-08 01:25:28 +03:00
There are many other ways to get involved with the community and to
2015-12-09 22:45:43 +03:00
participate in this project:
- Use the product, submitting GitHub issues when a problem is found
- Help code review pull requests and participate in issue threads
- Submit a new feature request as an issue
- Help answer questions on forums such as Stack Overflow
- Tell others about the project on Twitter, your blog, etc.
### Reporting issues
2022-10-08 01:25:28 +03:00
Issues unrelated to security should be submitted through this
2015-12-09 22:45:43 +03:00
project's Issues tab on GitHub.
Please follow the following guidance when possible:
2022-10-08 01:25:28 +03:00
- Search or browse the existing issues to make sure the issue
2015-12-09 22:45:43 +03:00
has not already been reported
- Provide a detailed description of the issue including:
- What feature the issue appears in
2022-10-08 01:25:28 +03:00
- Under what circumstances the issue appears (your OS, environment
2015-12-09 22:45:43 +03:00
and build info)
- What the desired behavior is
- What the impact of the issue is
- Any information that will be helpful to help reproduce the issue
2022-10-08 01:25:28 +03:00
We're excited to have a dialog and work together to make the
2015-12-09 22:45:43 +03:00
project a success!
#### Reporting security issues and bugs
2022-10-08 01:25:28 +03:00
Security issues and bugs should be reported privately, via email, to the
Microsoft Security Response Center (MSRC) at
[secure@microsoft.com](mailto:secure@microsoft.com). You should receive
a response within 24 hours. If for some reason you do not, please follow
up via email to ensure we received your original message. Further information,
2015-12-09 22:45:43 +03:00
including the MSRC PGP key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/ff852094.aspx).
## Attribution of changes
2022-10-08 01:25:28 +03:00
We do not want the source code to be full of random attributions. Git
handles attribution by storing the committer information from changes
2015-12-09 22:45:43 +03:00
and GitHub helps surface this information in its contributor graphs.
## Consistent source code headers
2022-10-08 01:25:28 +03:00
The license and copyright protections for this project's direct
2015-12-09 22:45:43 +03:00
contributions should appear at the top of every source file.
2022-10-08 01:25:28 +03:00
If you contribute a change that includes a new source file, please
take the time to make sure that the header is consistent with the
2015-12-09 22:45:43 +03:00
rest of the project.
<!--
### Write Access
2022-10-08 01:25:28 +03:00
Write access is a very special privilege that is granted to project
maintainers and contributions with a track record of substantial
2015-12-09 22:45:43 +03:00
high-quality changes and community participation.
Even with write access, the code reviews and pull request process
2022-10-08 01:25:28 +03:00
should be used.
2015-12-09 22:45:43 +03:00
-->
<!-- Specific governance instructions can be added as appropriate -->