Everyone is welcome to contribute to Swift for TensorFlow. Contributing doesn't just mean submitting code - there are many different ways to get involved, including reporting bugs, improving documentation, writing models or tutorials, submitting deep learning building blocks, or participating in API and infrastructure design discussions.
The Swift for TensorFlow community is guided by our Code of Conduct, which we encourage everybody to read before participating.
Reporting bugs is a great way for anyone to help improve Swift for TensorFlow. Swift for TensorFlow has a JIRA project on the bugs.swift.org JIRA instance. To report a bug, use this issue template.
Please follow the Swift project's bug reporting guidelines while reporting bugs.
Improving documentation is another great way for anyone to contribute to Swift for TensorFlow. Documentation is located in a few different places:
- Tutorials and design documents are located at https://github.com/tensorflow/swift.
- API documentation is located at https://www.tensorflow.org/swift/api_docs. Documentation is generated from source code comments in the TensorFlow standard library and the deep learning library.
For small documentation improvements, feel free to send a PR directly to the relevant repository. For bigger changes, you might want to file a JIRA issue or ask on the mailing list before starting, as described in the code contribution workflow.
If you are interested in contributing code, but are not sure how to get started, take a look at the Swift for TensorFlow Starter Bugs. It's a curated list of small, self-contained bugs that are great for diving in and getting a sense of how everything works. If you have any questions about these bugs, feel free to ask in a comment on JIRA or on the mailing list!
Once you are ready to start working on a starter issue, assign it to yourself in JIRA and follow the code contribution workflow.
The Swift for TensorFlow Deep Learning Library contains building blocks for deep learning, like layers, loss functions, and optimizers. It's very new, so it's some of standard building blocks. We welcome contributions!
Follow the code contribution workflow when contributing building blocks.
We discuss preliminary feature requests and ideas on the mailing list. You can participate by sending your own feature requests and ideas to the mailing list, or by commenting on others' feature requests and ideas.
Once an idea has been fleshed out, the person or people driving it write a proposal and send it as a PR to the proposals directory. Further discussion happens on that PR, and the PR gets merged if the design gets accepted. You can participate by proposing your own proposals, or by commenting on others' proposals.
Before contributing code, make sure you know how to compile and test the repository that you want to contribute to:
- Swift for TensorFlow Deep Learning Library: development instructions
- Swift for TensorFlow Compiler: development instructions
Here is the standard workflow for contributing code to Swift for TensorFlow:
- Coordinate with the community to make sure you're not duplicating work or building something that conflicts with something else. There are a few ways to do this, depending on the size and scope of the change:
- For tiny changes (e.g. fixing typos, clarifying documentation), you can skip this step and jump straight to sending a PR.
- For straightforward changes (e.g. fixing known bugs, adding deep learning building blocks, or implementing features that have already been designed), find an issue in the Swift for TensorFlow JIRA project and assign it to yourself. This lets others know that you are working on the change, so that they don't waste effort working on the same change. If there is no issue for your change, file one. If you decide not to work on a change, please unassign the issue from yourself to give others a chance to work on it.
- For large changes, or changes that affect others (e.g. adding a new feature, or changing an existing API), start a discussion on the mailing list before you start working on it. If the change has a large design space, we might recommend having a design discussion.
- Start working on your code, and send a PR to the relevant repository when it's ready for review. Take a look at the Swift project code contribution guidelines for tips on how to structure your code and PRs.
- A reviewer will take a look at your PR and might ask for some changes. This is an iterative process that continues until the code is ready to be merged.
- Once the code is ready to be merged, someone with commit access to the repository will merge it.
- Remember to close any JIRA issues related to the change.