Skip to content

Latest commit

 

History

History
115 lines (73 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

115 lines (73 loc) · 3.93 KB
Raw

Contributing

This guide is written for both internal contributors (Phylum, Inc. employees) and external/community contributors. Community contributions are possible by submitting issues.

Types of Contributions

Report Bugs

Report bugs (e.g., typos, broken links, etc.) at https://github.com/phylum-dev/documentation/issues.

Please use the "bug report" template which should remind you to include:

  • A clear and consise description of the bug
  • Where to find it
  • Expected behavior
  • Screenshots, where appropriate
  • Additional context
    • Your web browser name and version
    • Any details about your local setup that might be helpful in troubleshooting

Security issues should be disclosed following the security policy.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/phylum-dev/documentation/issues.

If you are proposing new content, please use the "new content" template which should remind you to:

  • Explain in detail the content desired
  • Explain how the content should look and feel
  • Suggest page name and metadata for new pages
  • Provide mockups/outlines where possible

Fix Bugs

Internal contributors can look through the GitHub issues for bugs to work on.

Write New Content

Internal contributors can look through the GitHub issues for desired new content to write.

Security Disclosures

Found a security issue in this repository? See the security policy for details on coordinated disclosure.

Code of Conduct

Everyone participating in the Phylum documentation project, and in particular in the issue tracker and pull requests, is expected to treat other people with respect and more generally to follow the guidelines articulated in the Code of Conduct.

Local Development

Internal contributors (Phylum, Inc. employees) are able to contribute with content submissions and pull requests (PRs). Here's how to set up the Phylum documentation repository for local development.

  1. Clone the phylum-dev/documentation repo locally

    git clone [email protected]:phylum-dev/documentation.git

  2. Create a branch for local development:

    git checkout -b <name-of-your-branch>

    Now you can make your changes locally.

  3. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Description of the changes goes here"
git push --set-upstream origin <name-of-your-branch>

  4. Submit a pull request (PR) through the GitHub website

Release Process

The phylum-dev/documentation project repository currently makes use of GitHub flow, which is also known as trunk-based development. Specifically, for this repository, there is a single long-living branch:

  • main
    • This is the default branch
    • Feature branches are created from here
    • Production documentation is pushed from here
    • This is a protected branch

Releases happen automatically, every time there is a push to the main branch.

Tips

Page changes

If an existing published URI changes (e.g., /analytics/original_name --> /analytics/new_name), for whatever reason, ensure a redirect is added to ensure existing links in the wild don't break. Currently, this is done by updating the Docusaurus plugin-client-redirects plugin configuration in the larger site/docusaurus.config.js configuration file.

Contact

If there are any outstanding questions about contributing to the Phylum documentation, they can be asked on the issue tracker: https://github.com/phylum-dev/documentation/issues.

As an alternative, you can also email [email protected].