Skip to content

Latest commit

 

History

History
134 lines (110 loc) · 5.52 KB

CONTRIBUTING.md

File metadata and controls

134 lines (110 loc) · 5.52 KB
Raw

Contributing

The Common Workflow Language project is an open source project, and we welcome contributions of all kinds: new sections, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.

Contributor Agreement

By contributing, you agree that we may redistribute your work under our license. In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved in the Common Workflow Language project agrees to abide by our code of conduct.

How to Contribute

The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error. This is a good way to introduce yourself and to meet some of our community members.

  1. If you do not have a GitHub account, you can send us comments by email. However, we will be able to respond more quickly if you use one of the other methods described below.

  2. If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion.

  3. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are [included below][#using-github].

  4. To build and run the user guide locally, see [building][#building].

Pull requests include an automatic preview provided by ReadTheDocs.

What to Contribute

There are many ways to contribute, like updating or filling in the documentation and submitting bug reports about things that don't work, aren't clear, or are missing. If you are looking for ideas, please see the list of issues for this repository, or the issues for [Common Workflow Language][cwl-issues] project itself.

Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we are on our own. Reviews from novices and newcomers are particularly valuable: it's easy for people who have been using these materials for a while to forget how impenetrable some of this material can be, so fresh eyes are always welcome.

Using GitHub

If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub. To manage changes, we follow GitHub flow. To use the web interface for contributing:

  1. Fork the originating repository to your GitHub profile.
  2. Within your version of the forked repository, move to the main branch and create a new branch for each significant change being made.
  3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
  4. Commit all changed files within the appropriate branches.
  5. Create individual pull requests from each of your changed branches to the main branch within the originating repository.
  6. If you receive feedback, make changes using your issue-specific branches of the forked repository and the pull requests will update automatically.
  7. Repeat as needed until all feedback has been addressed.

When starting work, please make sure your clone of the originating main branch is up-to-date before creating your own revision-specific branch(es) from there. Additionally, please only work from your newly-created branch(es) and not your clone of the originating main branch. Lastly, published copies of all the sections are available in the main branch of the originating repository for reference while revising.

Building

The user guide uses Sphinx, a Python documentation tool. You must have a recent version of Python 3.6+ installed to build the project locally. It is also recommended having make (otherwise look at the commands used in Makefile).

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate
# Install the dependencies in your virtual environment
(venv) pip install -e .[all]
# Create the HTML to visualize locally
(venv) make html
(venv) firefox _build/index.html
# Or you can start a serve that watches for local file changes
(venv) make watch
# Open <http://localhost:8000/> in your browser

NOTE: When you modify the packages installed with apt or pip, please verify if the change needs to be applied to either or to both of CI and readthedocs. ReadTheDocs builds and deploys previews. CI builds and deploys production (GitHub Actions). Failing to update both may result in previews generated correctly, but failure to deploy the production version after the pull request gets merged.

Other Resources

General discussion of Common Workflow Language project happens on the discussion mailing list, which everyone is welcome to join.