Skip to content

Commit 7c4b13f

Browse files
authored
Update README with coding standards and PR guidelines
Added coding standards section and clarified PR process.
1 parent 0570c9a commit 7c4b13f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUIL
4646

4747
Troubleshooting: If you run into issues, please open an [issue](https://github.com/finos/rune-python-generator/issues). This helps us improve the guide for everyone.
4848

49+
### Coding Standards
50+
51+
- Indentation: Since Python is sensitive to indentation, ensure your submission uses four spaces for each indentation instead of tabs.
52+
- Java vs xTend: since the intention is to replace xTend, all new code should be written in Java. Ideally, changes to existing code will migrate xTend code to Java.
53+
4954
### 1. Building with Maven
5055

5156
Start by cloning the project: `git clone https://github.com/finos/rune-python-generator`
@@ -109,7 +114,9 @@ We welcome contributions! Please follow these steps to get started:
109114
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
110115
4. Commit your changes (`git commit -am 'Add some fooBar'`)
111116
5. Push to the branch (`git push origin feature/fooBar`)
112-
6. Create a new Pull Request
117+
6. Create a new Pull Request: the intention is to ensure that Main is always production ready and matches a release.
118+
- Simple / short running changes : the PR should be to Main
119+
- Complex / long running changes: the recommendation is to complete all the changes in a staging branch, such as Develop or another branch of your choosing. Once the change is complete and passes all tests, then raise the PR to main from your staging branch.
113120

114121
**NOTE: FINOS repositories require an executed and active FINOS Individual Contributor License Agreement (ICLA) or an executed and active FINOS Corporate Contribution License Agreement (CCLA). The FINOS Clabot tool (or EasyCLA) will flag and block commits from individuals not covered. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.**
115122

0 commit comments

Comments
 (0)